Skip to content
This repository has been archived by the owner on May 13, 2024. It is now read-only.

Commit

Permalink
Merge pull request #267 from mariovw-deriv/binary-com/update_schemas_…
Browse files Browse the repository at this point in the history
…22Nov

Binary com/update schemas 22 nov
  • Loading branch information
ali-hosseini-deriv authored Nov 22, 2023
2 parents 2593a78 + 2f85bad commit 31a2e83
Show file tree
Hide file tree
Showing 128 changed files with 712 additions and 281 deletions.
2 changes: 2 additions & 0 deletions _data/v3.yml
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,8 @@ groups:
title: 'Copy Trading: Statistics'
- name: crypto_config
title: Cryptocurrency configurations
- name: crypto_estimations
title: Cryptocurrency Estimations
- name: document_upload
title: Document Upload
- name: economic_calendar
Expand Down
8 changes: 6 additions & 2 deletions config/v3/active_symbols/send.json
Original file line number Diff line number Diff line change
Expand Up @@ -52,10 +52,14 @@
"basic"
]
},
"loginid": {
"description": "[Optional] The login id of the user. If left unspecified, it defaults to the initial authorized token's login id.",
"type": "string",
"pattern": "^[A-Za-z]+[0-9]+$"
},
"passthrough": {
"description": "[Optional] Used to pass data through the websocket, which may be retrieved via the `echo_req` output field. Maximum size is 3500 bytes.",
"type": "object",
"maxSize": 3500
"type": "object"
},
"req_id": {
"description": "[Optional] Used to map request to response.",
Expand Down
8 changes: 6 additions & 2 deletions config/v3/api_token/send.json
Original file line number Diff line number Diff line change
Expand Up @@ -53,10 +53,14 @@
1
]
},
"loginid": {
"description": "[Optional] The login id of the user. If left unspecified, it defaults to the initial authorized token's login id.",
"type": "string",
"pattern": "^[A-Za-z]+[0-9]+$"
},
"passthrough": {
"description": "[Optional] Used to pass data through the websocket, which may be retrieved via the `echo_req` output field. Maximum size is 3500 bytes.",
"type": "object",
"maxSize": 3500
"type": "object"
},
"req_id": {
"description": "[Optional] Used to map request to response.",
Expand Down
8 changes: 6 additions & 2 deletions config/v3/app_delete/send.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,14 @@
"description": "Application app_id",
"type": "integer"
},
"loginid": {
"description": "[Optional] The login id of the user. If left unspecified, it defaults to the initial authorized token's login id.",
"type": "string",
"pattern": "^[A-Za-z]+[0-9]+$"
},
"passthrough": {
"description": "[Optional] Used to pass data through the websocket, which may be retrieved via the `echo_req` output field. Maximum size is 3500 bytes.",
"type": "object",
"maxSize": 3500
"type": "object"
},
"req_id": {
"description": "[Optional] Used to map request to response.",
Expand Down
8 changes: 6 additions & 2 deletions config/v3/app_get/send.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,14 @@
"description": "Application app_id",
"type": "integer"
},
"loginid": {
"description": "[Optional] The login id of the user. If left unspecified, it defaults to the initial authorized token's login id.",
"type": "string",
"pattern": "^[A-Za-z]+[0-9]+$"
},
"passthrough": {
"description": "[Optional] Used to pass data through the websocket, which may be retrieved via the `echo_req` output field. Maximum size is 3500 bytes.",
"type": "object",
"maxSize": 3500
"type": "object"
},
"req_id": {
"description": "[Optional] Used to map request to response.",
Expand Down
8 changes: 6 additions & 2 deletions config/v3/app_list/send.json
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,14 @@
1
]
},
"loginid": {
"description": "[Optional] The login id of the user. If left unspecified, it defaults to the initial authorized token's login id.",
"type": "string",
"pattern": "^[A-Za-z]+[0-9]+$"
},
"passthrough": {
"description": "[Optional] Used to pass data through the websocket, which may be retrieved via the `echo_req` output field. Maximum size is 3500 bytes.",
"type": "object",
"maxSize": 3500
"type": "object"
},
"req_id": {
"description": "[Optional] Used to map request to response.",
Expand Down
8 changes: 6 additions & 2 deletions config/v3/app_markup_details/send.json
Original file line number Diff line number Diff line change
Expand Up @@ -84,10 +84,14 @@
"minItems": 0,
"uniqueItems": true
},
"loginid": {
"description": "[Optional] The login id of the user. If left unspecified, it defaults to the initial authorized token's login id.",
"type": "string",
"pattern": "^[A-Za-z]+[0-9]+$"
},
"passthrough": {
"description": "[Optional] Used to pass data through the websocket, which may be retrieved via the `echo_req` output field. Maximum size is 3500 bytes.",
"type": "object",
"maxSize": 3500
"type": "object"
},
"req_id": {
"description": "[Optional] Used to map request to response.",
Expand Down
8 changes: 6 additions & 2 deletions config/v3/app_markup_statistics/send.json
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,14 @@
"type": "string",
"pattern": "^([0-9]{4}-(0?[1-9]|1[012])-(0?[1-9]|[12][0-9]|3[01]) ([01]?[0-9]|2[0-3]):([0-5]?[0-9]):([0-5]?[0-9])|[0-9]{1,10})$"
},
"loginid": {
"description": "[Optional] The login id of the user. If left unspecified, it defaults to the initial authorized token's login id.",
"type": "string",
"pattern": "^[A-Za-z]+[0-9]+$"
},
"passthrough": {
"description": "[Optional] Used to pass data through the websocket, which may be retrieved via the `echo_req` output field. Maximum size is 3500 bytes.",
"type": "object",
"maxSize": 3500
"type": "object"
},
"req_id": {
"description": "[Optional] Used to map request to response.",
Expand Down
8 changes: 6 additions & 2 deletions config/v3/app_register/send.json
Original file line number Diff line number Diff line change
Expand Up @@ -77,10 +77,14 @@
"type": "string",
"pattern": "^[a-z][a-z0-9.+\\-]*://[0-9a-zA-Z\\.-]+[\\%\\/\\w \\.-]*$"
},
"loginid": {
"description": "[Optional] The login id of the user. If left unspecified, it defaults to the initial authorized token's login id.",
"type": "string",
"pattern": "^[A-Za-z]+[0-9]+$"
},
"passthrough": {
"description": "[Optional] Used to pass data through the websocket, which may be retrieved via the `echo_req` output field. Maximum size is 3500 bytes.",
"type": "object",
"maxSize": 3500
"type": "object"
},
"req_id": {
"description": "[Optional] Used to map request to response.",
Expand Down
8 changes: 6 additions & 2 deletions config/v3/app_update/send.json
Original file line number Diff line number Diff line change
Expand Up @@ -74,10 +74,14 @@
"type": "string",
"pattern": "^[a-z][a-z0-9.+\\-]*://[0-9a-zA-Z\\.-]+[\\%\\/\\w \\.-]*$"
},
"loginid": {
"description": "[Optional] The login id of the user. If left unspecified, it defaults to the initial authorized token's login id.",
"type": "string",
"pattern": "^[A-Za-z]+[0-9]+$"
},
"passthrough": {
"description": "[Optional] Used to pass data through the websocket, which may be retrieved via the `echo_req` output field. Maximum size is 3500 bytes.",
"type": "object",
"maxSize": 3500
"type": "object"
},
"req_id": {
"description": "[Optional] Used to map request to response.",
Expand Down
8 changes: 6 additions & 2 deletions config/v3/asset_index/send.json
Original file line number Diff line number Diff line change
Expand Up @@ -44,10 +44,14 @@
"champion-virtual"
]
},
"loginid": {
"description": "[Optional] The login id of the user. If left unspecified, it defaults to the initial authorized token's login id.",
"type": "string",
"pattern": "^[A-Za-z]+[0-9]+$"
},
"passthrough": {
"description": "[Optional] Used to pass data through the websocket, which may be retrieved via the `echo_req` output field. Maximum size is 3500 bytes.",
"type": "object",
"maxSize": 3500
"type": "object"
},
"req_id": {
"description": "[Optional] Used to map request to response.",
Expand Down
13 changes: 11 additions & 2 deletions config/v3/authorize/send.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,19 @@
0
]
},
"tokens": {
"description": "Additional Authentication tokens of authorized user that may be used in this session. Upto 10 tokens.",
"type": "array",
"items": {
"type": "string",
"pattern": "^[\\w\\-]{1,128}$"
},
"maxItems": 10,
"sensitive": 1
},
"passthrough": {
"description": "[Optional] Used to pass data through the websocket, which may be retrieved via the `echo_req` output field. Maximum size is 3500 bytes.",
"type": "object",
"maxSize": 3500
"type": "object"
},
"req_id": {
"description": "[Optional] Used to map request to response.",
Expand Down
8 changes: 6 additions & 2 deletions config/v3/balance/send.json
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,14 @@
1
]
},
"loginid": {
"description": "[Optional] The login id of the user. If left unspecified, it defaults to the initial authorized token's login id.",
"type": "string",
"pattern": "^[A-Za-z]+[0-9]+$"
},
"passthrough": {
"description": "[Optional] Used to pass data through the websocket, which may be retrieved via the `echo_req` output field. Maximum size is 3500 bytes.",
"type": "object",
"maxSize": 3500
"type": "object"
},
"req_id": {
"description": "[Optional] Used to map request to response.",
Expand Down
8 changes: 6 additions & 2 deletions config/v3/buy/send.json
Original file line number Diff line number Diff line change
Expand Up @@ -208,10 +208,14 @@
1
]
},
"loginid": {
"description": "[Optional] The login id of the user. If left unspecified, it defaults to the initial authorized token's login id.",
"type": "string",
"pattern": "^[A-Za-z]+[0-9]+$"
},
"passthrough": {
"description": "[Optional] Used to pass data through the websocket, which may be retrieved via the `echo_req` output field. Maximum size is 3500 bytes.",
"type": "object",
"maxSize": 3500
"type": "object"
},
"req_id": {
"description": "[Optional] Used to map request to response.",
Expand Down
8 changes: 6 additions & 2 deletions config/v3/buy_contract_for_multiple_accounts/send.json
Original file line number Diff line number Diff line change
Expand Up @@ -164,10 +164,14 @@
},
"sensitive": 1
},
"loginid": {
"description": "[Optional] The login id of the user. If left unspecified, it defaults to the initial authorized token's login id.",
"type": "string",
"pattern": "^[A-Za-z]+[0-9]+$"
},
"passthrough": {
"description": "[Optional] Used to pass data through the websocket, which may be retrieved via the `echo_req` output field. Maximum size is 3500 bytes.",
"type": "object",
"maxSize": 3500
"type": "object"
},
"req_id": {
"description": "[Optional] Used to map request to response.",
Expand Down
8 changes: 6 additions & 2 deletions config/v3/cancel/send.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,14 @@
"description": "Value should be the `contract_id` which received from the `portfolio` call.",
"type": "integer"
},
"loginid": {
"description": "[Optional] The login id of the user. If left unspecified, it defaults to the initial authorized token's login id.",
"type": "string",
"pattern": "^[A-Za-z]+[0-9]+$"
},
"passthrough": {
"description": "[Optional] Used to pass data through the websocket, which may be retrieved via the `echo_req` output field. Maximum size is 3500 bytes.",
"type": "object",
"maxSize": 3500
"type": "object"
},
"req_id": {
"description": "[Optional] Used to map request to response.",
Expand Down
8 changes: 6 additions & 2 deletions config/v3/cashier/send.json
Original file line number Diff line number Diff line change
Expand Up @@ -62,10 +62,14 @@
"type": "string",
"pattern": "^\\w{8,128}$"
},
"loginid": {
"description": "[Optional] The login id of the user. If left unspecified, it defaults to the initial authorized token's login id.",
"type": "string",
"pattern": "^[A-Za-z]+[0-9]+$"
},
"passthrough": {
"description": "[Optional] Used to pass data through the websocket, which may be retrieved via the `echo_req` output field. Maximum size is 3500 bytes.",
"type": "object",
"maxSize": 3500
"type": "object"
},
"req_id": {
"description": "[Optional] Used to map request to response.",
Expand Down
8 changes: 6 additions & 2 deletions config/v3/contract_update/send.json
Original file line number Diff line number Diff line change
Expand Up @@ -46,10 +46,14 @@
}
}
},
"loginid": {
"description": "[Optional] The login id of the user. If left unspecified, it defaults to the initial authorized token's login id.",
"type": "string",
"pattern": "^[A-Za-z]+[0-9]+$"
},
"passthrough": {
"description": "[Optional] Used to pass data through the websocket, which may be retrieved via the `echo_req` output field. Maximum size is 3500 bytes.",
"type": "object",
"maxSize": 3500
"type": "object"
},
"req_id": {
"description": "[Optional] Used to map request to response.",
Expand Down
8 changes: 6 additions & 2 deletions config/v3/contract_update_history/send.json
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,14 @@
"maximum": 999,
"minimum": 1
},
"loginid": {
"description": "[Optional] The login id of the user. If left unspecified, it defaults to the initial authorized token's login id.",
"type": "string",
"pattern": "^[A-Za-z]+[0-9]+$"
},
"passthrough": {
"description": "[Optional] Used to pass data through the websocket, which may be retrieved via the `echo_req` output field. Maximum size is 3500 bytes.",
"type": "object",
"maxSize": 3500
"type": "object"
},
"req_id": {
"description": "[Optional] Used to map request to response.",
Expand Down
8 changes: 6 additions & 2 deletions config/v3/contracts_for/send.json
Original file line number Diff line number Diff line change
Expand Up @@ -57,10 +57,14 @@
"basic"
]
},
"loginid": {
"description": "[Optional] The login id of the user. If left unspecified, it defaults to the initial authorized token's login id.",
"type": "string",
"pattern": "^[A-Za-z]+[0-9]+$"
},
"passthrough": {
"description": "[Optional] Used to pass data through the websocket, which may be retrieved via the `echo_req` output field. Maximum size is 3500 bytes.",
"type": "object",
"maxSize": 3500
"type": "object"
},
"req_id": {
"description": "[Optional] Used to map request to response.",
Expand Down
8 changes: 6 additions & 2 deletions config/v3/copy_start/send.json
Original file line number Diff line number Diff line change
Expand Up @@ -58,10 +58,14 @@
}
]
},
"loginid": {
"description": "[Optional] The login id of the user. If left unspecified, it defaults to the initial authorized token's login id.",
"type": "string",
"pattern": "^[A-Za-z]+[0-9]+$"
},
"passthrough": {
"description": "[Optional] Used to pass data through the websocket, which may be retrieved via the `echo_req` output field. Maximum size is 3500 bytes.",
"type": "object",
"maxSize": 3500
"type": "object"
},
"req_id": {
"description": "[Optional] Used to map request to response.",
Expand Down
8 changes: 6 additions & 2 deletions config/v3/copy_stop/send.json
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,14 @@
"pattern": "^[\\w\\s-]{15,32}$",
"sensitive": 1
},
"loginid": {
"description": "[Optional] The login id of the user. If left unspecified, it defaults to the initial authorized token's login id.",
"type": "string",
"pattern": "^[A-Za-z]+[0-9]+$"
},
"passthrough": {
"description": "[Optional] Used to pass data through the websocket, which may be retrieved via the `echo_req` output field. Maximum size is 3500 bytes.",
"type": "object",
"maxSize": 3500
"type": "object"
},
"req_id": {
"description": "[Optional] Used to map request to response.",
Expand Down
8 changes: 6 additions & 2 deletions config/v3/copytrading_list/send.json
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,14 @@
1
]
},
"loginid": {
"description": "[Optional] The login id of the user. If left unspecified, it defaults to the initial authorized token's login id.",
"type": "string",
"pattern": "^[A-Za-z]+[0-9]+$"
},
"passthrough": {
"description": "[Optional] Used to pass data through the websocket, which may be retrieved via the `echo_req` output field. Maximum size is 3500 bytes.",
"type": "object",
"maxSize": 3500
"type": "object"
},
"req_id": {
"description": "[Optional] Used to map request to response.",
Expand Down
3 changes: 1 addition & 2 deletions config/v3/copytrading_statistics/send.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,7 @@
},
"passthrough": {
"description": "[Optional] Used to pass data through the websocket, which may be retrieved via the `echo_req` output field. Maximum size is 3500 bytes.",
"type": "object",
"maxSize": 3500
"type": "object"
},
"req_id": {
"description": "[Optional] Used to map request to response.",
Expand Down
Loading

1 comment on commit 31a2e83

@vercel
Copy link

@vercel vercel bot commented on 31a2e83 Nov 22, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

deriv-api-docs – ./

deriv-api-docs-git-master.binary.sx
deriv-api-docs.binary.sx

Please sign in to comment.