Skip to content

Commit b60c215

Browse files
ali-hosseini-derivali-hosseini-deriv
committed
Merge branch 'master' of https://github.com/deriv-com/deriv-api-docs into ako/change-DR-plan-to-vercel
2 parents e33c412 + e6a13b9 commit b60c215

File tree

140 files changed

+1524
-671
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

140 files changed

+1524
-671
lines changed

‎_data/v3.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -215,6 +215,8 @@ groups:
215215
title: Ticks History
216216
- name: time
217217
title: Server Time
218+
- name: tin_validations
219+
title: Tax Identification Number Validations
218220
- name: tnc_approval
219221
title: Terms and Conditions Approval
220222
- name: topup_virtual
@@ -239,8 +241,6 @@ groups:
239241
title: Unsubscribe Email
240242
- name: verify_email
241243
title: Verify Email
242-
- name: verify_email_cellxpert
243-
title: Verify Email Cellxpert
244244
- name: website_config
245245
title: Server Config
246246
- name: website_status

‎config/v3/active_symbols/send.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@
114114
]
115115
},
116116
"loginid": {
117-
"description": "[Optional] The login id of the user. If left unspecified, it defaults to the initial authorized token's login id.",
117+
"description": "[Optional] The login id of the user. Mandatory when multiple tokens were provided during authorize.",
118118
"type": "string",
119119
"pattern": "^[A-Za-z]+[0-9]+$"
120120
},

‎config/v3/api_token/send.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@
5454
]
5555
},
5656
"loginid": {
57-
"description": "[Optional] The login id of the user. If left unspecified, it defaults to the initial authorized token's login id.",
57+
"description": "[Optional] The login id of the user. Mandatory when multiple tokens were provided during authorize.",
5858
"type": "string",
5959
"pattern": "^[A-Za-z]+[0-9]+$"
6060
},

‎config/v3/app_delete/send.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
"type": "integer"
1818
},
1919
"loginid": {
20-
"description": "[Optional] The login id of the user. If left unspecified, it defaults to the initial authorized token's login id.",
20+
"description": "[Optional] The login id of the user. Mandatory when multiple tokens were provided during authorize.",
2121
"type": "string",
2222
"pattern": "^[A-Za-z]+[0-9]+$"
2323
},

‎config/v3/app_get/send.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
"type": "integer"
1818
},
1919
"loginid": {
20-
"description": "[Optional] The login id of the user. If left unspecified, it defaults to the initial authorized token's login id.",
20+
"description": "[Optional] The login id of the user. Mandatory when multiple tokens were provided during authorize.",
2121
"type": "string",
2222
"pattern": "^[A-Za-z]+[0-9]+$"
2323
},

‎config/v3/app_list/send.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
]
2121
},
2222
"loginid": {
23-
"description": "[Optional] The login id of the user. If left unspecified, it defaults to the initial authorized token's login id.",
23+
"description": "[Optional] The login id of the user. Mandatory when multiple tokens were provided during authorize.",
2424
"type": "string",
2525
"pattern": "^[A-Za-z]+[0-9]+$"
2626
},

‎config/v3/app_markup_details/send.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@
8585
"uniqueItems": true
8686
},
8787
"loginid": {
88-
"description": "[Optional] The login id of the user. If left unspecified, it defaults to the initial authorized token's login id.",
88+
"description": "[Optional] The login id of the user. Mandatory when multiple tokens were provided during authorize.",
8989
"type": "string",
9090
"pattern": "^[A-Za-z]+[0-9]+$"
9191
},

‎config/v3/app_markup_statistics/send.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
"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})$"
3333
},
3434
"loginid": {
35-
"description": "[Optional] The login id of the user. If left unspecified, it defaults to the initial authorized token's login id.",
35+
"description": "[Optional] The login id of the user. Mandatory when multiple tokens were provided during authorize.",
3636
"type": "string",
3737
"pattern": "^[A-Za-z]+[0-9]+$"
3838
},

‎config/v3/app_register/send.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@
7878
"pattern": "^[a-z][a-z0-9.+\\-]*://[0-9a-zA-Z\\.-]+[\\%\\/\\w \\.-]*$"
7979
},
8080
"loginid": {
81-
"description": "[Optional] The login id of the user. If left unspecified, it defaults to the initial authorized token's login id.",
81+
"description": "[Optional] The login id of the user. Mandatory when multiple tokens were provided during authorize.",
8282
"type": "string",
8383
"pattern": "^[A-Za-z]+[0-9]+$"
8484
},

‎config/v3/app_update/send.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@
7575
"pattern": "^[a-z][a-z0-9.+\\-]*://[0-9a-zA-Z\\.-]+[\\%\\/\\w \\.-]*$"
7676
},
7777
"loginid": {
78-
"description": "[Optional] The login id of the user. If left unspecified, it defaults to the initial authorized token's login id.",
78+
"description": "[Optional] The login id of the user. Mandatory when multiple tokens were provided during authorize.",
7979
"type": "string",
8080
"pattern": "^[A-Za-z]+[0-9]+$"
8181
},

‎config/v3/asset_index/send.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141
]
4242
},
4343
"loginid": {
44-
"description": "[Optional] The login id of the user. If left unspecified, it defaults to the initial authorized token's login id.",
44+
"description": "[Optional] The login id of the user. Mandatory when multiple tokens were provided during authorize.",
4545
"type": "string",
4646
"pattern": "^[A-Za-z]+[0-9]+$"
4747
},

‎config/v3/authorize/send.json

+3-3
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
],
1111
"properties": {
1212
"authorize": {
13-
"description": "Authentication token. May be retrieved from https://www.binary.com/en/user/security/api_tokenws.html",
13+
"description": "Authentication token. May be retrieved from https://www.binary.com/en/user/security/api_tokenws.html. Set to MULTI when using multiple tokens.",
1414
"type": "string",
1515
"pattern": "^[\\w\\-]{1,128}$",
1616
"sensitive": 1
@@ -25,13 +25,13 @@
2525
]
2626
},
2727
"tokens": {
28-
"description": "Additional Authentication tokens of authorized user that may be used in this session. Upto 10 tokens.",
28+
"description": "Additional Authentication tokens of authorized user that may be used in this session. Upto 25 tokens.",
2929
"type": "array",
3030
"items": {
3131
"type": "string",
3232
"pattern": "^[\\w\\-]{1,128}$"
3333
},
34-
"maxItems": 10,
34+
"maxItems": 25,
3535
"sensitive": 1
3636
},
3737
"passthrough": {

‎config/v3/balance/send.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
]
3636
},
3737
"loginid": {
38-
"description": "[Optional] The login id of the user. If left unspecified, it defaults to the initial authorized token's login id.",
38+
"description": "[Optional] The login id of the user. Mandatory when multiple tokens were provided during authorize.",
3939
"type": "string",
4040
"pattern": "^[A-Za-z]+[0-9]+$"
4141
},

‎config/v3/buy/send.json

+5-1
Original file line numberDiff line numberDiff line change
@@ -171,6 +171,10 @@
171171
"type": "number",
172172
"minimum": 0
173173
},
174+
"payout_per_point": {
175+
"description": "[Optional] Clients can provide payout_per_point directly, and the barrier will be calculated based on this payout_per_point value.",
176+
"type": "number"
177+
},
174178
"product_type": {
175179
"description": "[Optional] The product type.",
176180
"type": "string",
@@ -209,7 +213,7 @@
209213
]
210214
},
211215
"loginid": {
212-
"description": "[Optional] The login id of the user. If left unspecified, it defaults to the initial authorized token's login id.",
216+
"description": "[Optional] The login id of the user. Mandatory when multiple tokens were provided during authorize.",
213217
"type": "string",
214218
"pattern": "^[A-Za-z]+[0-9]+$"
215219
},

‎config/v3/buy_contract_for_multiple_accounts/send.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@
165165
"sensitive": 1
166166
},
167167
"loginid": {
168-
"description": "[Optional] The login id of the user. If left unspecified, it defaults to the initial authorized token's login id.",
168+
"description": "[Optional] The login id of the user. Mandatory when multiple tokens were provided during authorize.",
169169
"type": "string",
170170
"pattern": "^[A-Za-z]+[0-9]+$"
171171
},

‎config/v3/cancel/send.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
"type": "integer"
1818
},
1919
"loginid": {
20-
"description": "[Optional] The login id of the user. If left unspecified, it defaults to the initial authorized token's login id.",
20+
"description": "[Optional] The login id of the user. Mandatory when multiple tokens were provided during authorize.",
2121
"type": "string",
2222
"pattern": "^[A-Za-z]+[0-9]+$"
2323
},

‎config/v3/cashier/send.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@
7070
"pattern": "^\\w{8,128}$"
7171
},
7272
"loginid": {
73-
"description": "[Optional] The login id of the user. If left unspecified, it defaults to the initial authorized token's login id.",
73+
"description": "[Optional] The login id of the user. Mandatory when multiple tokens were provided during authorize.",
7474
"type": "string",
7575
"pattern": "^[A-Za-z]+[0-9]+$"
7676
},

‎config/v3/confirm_email/send.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
"verification_code": {
3030
"description": "Email verification code (received from a `verify_email` call, which must be done first).",
3131
"type": "string",
32-
"pattern": "^\\w{8,128}$",
32+
"pattern": "^\\w{6,128}$",
3333
"sensitive": 1
3434
},
3535
"passthrough": {

‎config/v3/contract_update/send.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@
4747
}
4848
},
4949
"loginid": {
50-
"description": "[Optional] The login id of the user. If left unspecified, it defaults to the initial authorized token's login id.",
50+
"description": "[Optional] The login id of the user. Mandatory when multiple tokens were provided during authorize.",
5151
"type": "string",
5252
"pattern": "^[A-Za-z]+[0-9]+$"
5353
},

‎config/v3/contract_update_history/send.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
"minimum": 1
3333
},
3434
"loginid": {
35-
"description": "[Optional] The login id of the user. If left unspecified, it defaults to the initial authorized token's login id.",
35+
"description": "[Optional] The login id of the user. Mandatory when multiple tokens were provided during authorize.",
3636
"type": "string",
3737
"pattern": "^[A-Za-z]+[0-9]+$"
3838
},

‎config/v3/contracts_for/receive.json

+17
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,19 @@
111111
"CALL"
112112
]
113113
},
114+
"default_stake": {
115+
"description": "Default stake for the contract",
116+
"type": "number"
117+
},
118+
"display_number_of_contracts": {
119+
"description": "[Only for Turbos] Its selected payout per point",
120+
"type": "number",
121+
"examples": [
122+
0,
123+
1,
124+
2
125+
]
126+
},
114127
"exchange_name": {
115128
"description": "Name of exchange",
116129
"type": "string",
@@ -221,6 +234,10 @@
221234
"description": "Multiplier range.",
222235
"type": "array"
223236
},
237+
"payout_choices": {
238+
"description": "[Only for Turbos] Payout Choices",
239+
"type": "array"
240+
},
224241
"payout_limit": {
225242
"description": "Maximum payout.",
226243
"type": "number",

‎config/v3/contracts_for/send.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@
5454
]
5555
},
5656
"loginid": {
57-
"description": "[Optional] The login id of the user. If left unspecified, it defaults to the initial authorized token's login id.",
57+
"description": "[Optional] The login id of the user. Mandatory when multiple tokens were provided during authorize.",
5858
"type": "string",
5959
"pattern": "^[A-Za-z]+[0-9]+$"
6060
},

‎config/v3/contracts_for_company/receive.json

+4
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,10 @@
7575
"CALL"
7676
]
7777
},
78+
"default_stake": {
79+
"description": "Default stake for the contract",
80+
"type": "number"
81+
},
7882
"sentiment": {
7983
"description": "Type of sentiment.",
8084
"type": "string",

‎config/v3/copy_start/send.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@
5959
]
6060
},
6161
"loginid": {
62-
"description": "[Optional] The login id of the user. If left unspecified, it defaults to the initial authorized token's login id.",
62+
"description": "[Optional] The login id of the user. Mandatory when multiple tokens were provided during authorize.",
6363
"type": "string",
6464
"pattern": "^[A-Za-z]+[0-9]+$"
6565
},

‎config/v3/copy_stop/send.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
"sensitive": 1
2020
},
2121
"loginid": {
22-
"description": "[Optional] The login id of the user. If left unspecified, it defaults to the initial authorized token's login id.",
22+
"description": "[Optional] The login id of the user. Mandatory when multiple tokens were provided during authorize.",
2323
"type": "string",
2424
"pattern": "^[A-Za-z]+[0-9]+$"
2525
},

‎config/v3/copytrading_list/send.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
]
2121
},
2222
"loginid": {
23-
"description": "[Optional] The login id of the user. If left unspecified, it defaults to the initial authorized token's login id.",
23+
"description": "[Optional] The login id of the user. Mandatory when multiple tokens were provided during authorize.",
2424
"type": "string",
2525
"pattern": "^[A-Za-z]+[0-9]+$"
2626
},

‎config/v3/crypto_config/send.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
"pattern": "^[a-zA-Z0-9]{2,20}$"
2323
},
2424
"loginid": {
25-
"description": "[Optional] The login id of the user. If left unspecified, it defaults to the initial authorized token's login id.",
25+
"description": "[Optional] The login id of the user. Mandatory when multiple tokens were provided during authorize.",
2626
"type": "string",
2727
"pattern": "^[A-Za-z]+[0-9]+$"
2828
},

‎config/v3/crypto_estimations/send.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030
]
3131
},
3232
"loginid": {
33-
"description": "[Optional] The login id of the user. If left unspecified, it defaults to the initial authorized token's login id.",
33+
"description": "[Optional] The login id of the user. Mandatory when multiple tokens were provided during authorize.",
3434
"type": "string",
3535
"pattern": "^[A-Za-z]+[0-9]+$"
3636
},

‎config/v3/document_upload/send.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@
143143
}
144144
},
145145
"loginid": {
146-
"description": "[Optional] The login id of the user. If left unspecified, it defaults to the initial authorized token's login id.",
146+
"description": "[Optional] The login id of the user. Mandatory when multiple tokens were provided during authorize.",
147147
"type": "string",
148148
"pattern": "^[A-Za-z]+[0-9]+$"
149149
},

‎config/v3/exchange_rates/send.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@
4242
"pattern": "^[a-zA-Z0-9]{2,20}$"
4343
},
4444
"loginid": {
45-
"description": "[Optional] The login id of the user. If left unspecified, it defaults to the initial authorized token's login id.",
45+
"description": "[Optional] The login id of the user. Mandatory when multiple tokens were provided during authorize.",
4646
"type": "string",
4747
"pattern": "^[A-Za-z]+[0-9]+$"
4848
},

‎config/v3/get_account_status/send.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
]
2121
},
2222
"loginid": {
23-
"description": "[Optional] The login id of the user. If left unspecified, it defaults to the initial authorized token's login id.",
23+
"description": "[Optional] The login id of the user. Mandatory when multiple tokens were provided during authorize.",
2424
"type": "string",
2525
"pattern": "^[A-Za-z]+[0-9]+$"
2626
},

‎config/v3/get_financial_assessment/send.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
]
2121
},
2222
"loginid": {
23-
"description": "[Optional] The login id of the user. If left unspecified, it defaults to the initial authorized token's login id.",
23+
"description": "[Optional] The login id of the user. Mandatory when multiple tokens were provided during authorize.",
2424
"type": "string",
2525
"pattern": "^[A-Za-z]+[0-9]+$"
2626
},

‎config/v3/get_limits/send.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
]
2121
},
2222
"loginid": {
23-
"description": "[Optional] The login id of the user. If left unspecified, it defaults to the initial authorized token's login id.",
23+
"description": "[Optional] The login id of the user. Mandatory when multiple tokens were provided during authorize.",
2424
"type": "string",
2525
"pattern": "^[A-Za-z]+[0-9]+$"
2626
},

‎config/v3/get_self_exclusion/send.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
]
2121
},
2222
"loginid": {
23-
"description": "[Optional] The login id of the user. If left unspecified, it defaults to the initial authorized token's login id.",
23+
"description": "[Optional] The login id of the user. Mandatory when multiple tokens were provided during authorize.",
2424
"type": "string",
2525
"pattern": "^[A-Za-z]+[0-9]+$"
2626
},

‎config/v3/get_settings/receive.json

+4
Original file line numberDiff line numberDiff line change
@@ -200,6 +200,10 @@
200200
"verified"
201201
],
202202
"properties": {
203+
"carriers": {
204+
"description": "A list of available carriers (if empty assume Phone Number Verification is not available at the moment)",
205+
"type": "array"
206+
},
203207
"next_attempt": {
204208
"description": "(Optional) Indicates the timestamp for the next verification attempt",
205209
"type": "integer"

‎config/v3/get_settings/send.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
]
2121
},
2222
"loginid": {
23-
"description": "[Optional] The login id of the user. If left unspecified, it defaults to the initial authorized token's login id.",
23+
"description": "[Optional] The login id of the user. Mandatory when multiple tokens were provided during authorize.",
2424
"type": "string",
2525
"pattern": "^[A-Za-z]+[0-9]+$"
2626
},

‎config/v3/identity_verification_document_add/send.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@
4040
"pattern": "^[a-z]{2}$"
4141
},
4242
"loginid": {
43-
"description": "[Optional] The login id of the user. If left unspecified, it defaults to the initial authorized token's login id.",
43+
"description": "[Optional] The login id of the user. Mandatory when multiple tokens were provided during authorize.",
4444
"type": "string",
4545
"pattern": "^[A-Za-z]+[0-9]+$"
4646
},

0 commit comments

Comments
 (0)