diff --git a/docs/_client-libraries/_category_.json b/docs/_client-libraries/_category_.json deleted file mode 100644 index 81c50334e..000000000 --- a/docs/_client-libraries/_category_.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "label": "Client libraries", - "position": 5, - "link": { - "type": "generated-index", - "description": "Learn how to use Deriv websocket API features with our Client libraries" - } -} diff --git a/docs/_client-libraries/flutter/_category_.json b/docs/_client-libraries/flutter/_category_.json deleted file mode 100644 index 62a98168a..000000000 --- a/docs/_client-libraries/flutter/_category_.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "label": "Flutter Client", - "position": 2, - "link": { - "type": "generated-index", - "description": "Flutter Client docs" - } -} diff --git a/docs/_client-libraries/flutter/project-setup/index.md b/docs/_client-libraries/flutter/project-setup/index.md deleted file mode 100644 index 45b6add8a..000000000 --- a/docs/_client-libraries/flutter/project-setup/index.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -title: Project setup -sidebar_label: Setup -sidebar_position: 0 ---- - -Please check the library documentations [here](https://github.com/deriv-com/flutter-deriv-api) - -:::caution -We're gonna update these pages in the future when we have content for them -::: diff --git a/docs/_client-libraries/intro.md b/docs/_client-libraries/intro.md deleted file mode 100644 index 2687aee4f..000000000 --- a/docs/_client-libraries/intro.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: Introduction -sidebar_label: Introduction -sidebar_position: 0 -description: Introduction to Client Libraries ---- - -## Introduction diff --git a/docs/_client-libraries/python/_category_.json b/docs/_client-libraries/python/_category_.json deleted file mode 100644 index bbfdc1d79..000000000 --- a/docs/_client-libraries/python/_category_.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "label": "Python Client", - "position": 1, - "link": { - "type": "generated-index", - "description": "Python docs" - } -} diff --git a/docs/_client-libraries/python/project-setup/index.md b/docs/_client-libraries/python/project-setup/index.md deleted file mode 100644 index 272db9ba6..000000000 --- a/docs/_client-libraries/python/project-setup/index.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -title: Project Setup -sidebar_label: Setup -sidebar_position: 0 ---- - -Please check the library documentations [here](https://deriv-com.github.io/python-deriv-api/) - -:::caution -We're gonna update these pages in the future when we have content for them -::: diff --git a/docs/_client-libraries/typescript/_category_.json b/docs/_client-libraries/typescript/_category_.json deleted file mode 100644 index 8455b9321..000000000 --- a/docs/_client-libraries/typescript/_category_.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "label": "Typescript Client", - "position": 0, - "link": { - "type": "generated-index", - "description": "Typescript / Javascript docs" - } -} diff --git a/docs/_client-libraries/typescript/project-setup/index.md b/docs/_client-libraries/typescript/project-setup/index.md deleted file mode 100644 index 4a2beda77..000000000 --- a/docs/_client-libraries/typescript/project-setup/index.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -title: Project setup -sidebar_label: Setup -sidebar_position: 0 ---- - -Please check the library documentations [here](https://deriv-com.github.io/deriv-api/) - -:::caution -We're gonna update these pages in the future when we have content for them -::: diff --git a/docs/_faq/_category_.json b/docs/_faq/_category_.json deleted file mode 100644 index 5d82736aa..000000000 --- a/docs/_faq/_category_.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "label": "FAQ", - "position": 7, - "link": { - "type": "generated-index" - } -} diff --git a/docs/_faq/conditions-of-using-deriv-api/index.md b/docs/_faq/conditions-of-using-deriv-api/index.md deleted file mode 100644 index aa65ee3f1..000000000 --- a/docs/_faq/conditions-of-using-deriv-api/index.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: Conditions of using the Deriv API -sidebar_label: Conditions of using the Deriv API -sidebar_position: 1 -tags: - - faq -keywords: - - faq -description: 'Conditions of using the Deriv API' ---- - -The Deriv API is free of charge and is subject to our [terms and conditions](https://deriv.com/terms-and-conditions) and -[copyright](https://deriv.com/tnc/business-partners-general-terms.pdf). - -Should you run into any difficulties using it or if you need assistance, please contact us -via one of our support forums or via email. diff --git a/docs/_faq/how-can-you-earn-with-deriv-api/index.md b/docs/_faq/how-can-you-earn-with-deriv-api/index.md deleted file mode 100644 index 40fb08dbb..000000000 --- a/docs/_faq/how-can-you-earn-with-deriv-api/index.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: How can I earn with deriv API? -sidebar_label: How can I earn with deriv API? -sidebar_position: 1 -tags: - - faq -keywords: - - faq -description: 'How to earn with deriv API' ---- - -- You can earn commission on trades and payments your clients perform via - the websites and apps you create with Deriv API. Get more details about the - commission plans [here](https://deriv.com/partners/affiliate-ib). - -- You can also earn from markups on every contract purchased via a trading - app you created with Deriv API. The markup is defined by you and can be up - to 5%. - -Here is an example of how the markup is calculated: - -- To get a payout of 2 **USD** : Client stake without markup = 1.07 **USD** -- With the markup (e.g. 2%), a client pays : Client's stake with the markup = - Stake + (payout x markup) -- Client's stake with the markup = 1.07 **USD** + (2 **USD** x 2%) = 1.11 **USD** diff --git a/docs/_faq/what-can-you-do-with-deriv-api/index.md b/docs/_faq/what-can-you-do-with-deriv-api/index.md deleted file mode 100644 index 26bf1f063..000000000 --- a/docs/_faq/what-can-you-do-with-deriv-api/index.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: What can I do with deriv API? -sidebar_label: What can I do with deriv API? -sidebar_position: 0 -tags: - - faq -keywords: - - faq -description: 'deriv API features' ---- - -The Deriv API allows you to perform nearly all functions of the Deriv platforms, since -they share the same API. For our CFD platforms (Deriv MT5 and Deriv X), the API -functionality is only available for some account management actions. - -Our API users typically perform the following activities: - -- Build websites similar to Deriv but with different features. -- Create desktop apps to execute trades for themselves and their clients. -- Explore historical tick information. -- Automate services as payment agents. diff --git a/docs/_intro_backup.md b/docs/_intro_backup.md deleted file mode 100644 index 9033c2963..000000000 --- a/docs/_intro_backup.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: Quick start -hide_title: false -draft: false -sidebar_label: Quick start -sidebar_position: 0 -tags: - - introduction -keywords: - - trading app - - api code - - api example -description: Get an overview of the available Deriv API code examples and languages, and how to use it to create your trading app. ---- - -Our Documentation is divided in several sections: - -- [Setting up a deriv app](/docs/setting-up-a-deriv-application.md) -- [Terminology](category/terminology) -- [Core Concepts](category/core-concepts) -- [Languages](category/languages) -- [Client Libraries](category/client-libraries) -- [Guides](category/guides) -- [FAQ](category/faq) - -### Quick Start - -Have a look at the [Core Concept](category/core-concepts) and [Terminology](category/terminology) pages and take your time to read through it. These concepts will help you get familiar with our websocket server api and how to use it more efficiently. They are not related to any of our frameworks or libraries. - -When you read through the [Core Concept](category/core-concepts) and [Terminology](category/terminology) pages, you can start choosing your implementation approach based on the language / framework / library you want to use in your application. - -Using our [Client Libraries](category/client-libraries) is optional and you can get the same result with the tutorials provided in [Languages Section](category/languages) as well, but our client libraries provide more `robust`, `type safe` API calls for you. - -### Using our websocket server with just languages features - -If you want to use our websocket server api with a specific coding language, then have a look at the [Languages Section](category/languages) and continue your journey from there. - -:::caution -We suggest using our [Client Libraries](category/client-libraries), since they give you better developer experience. -::: diff --git a/docs/_terminology/_category_.json b/docs/_terminology/_category_.json deleted file mode 100644 index 9f9f1484f..000000000 --- a/docs/_terminology/_category_.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "label": "Terminology", - "position": 1, - "link": { - "type": "generated-index", - "description": "Learn about our Terminology" - } -} diff --git a/docs/_terminology/account/Identity-verfication-add-document/index.md b/docs/_terminology/account/Identity-verfication-add-document/index.md deleted file mode 100644 index deb9d862e..000000000 --- a/docs/_terminology/account/Identity-verfication-add-document/index.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: Identity Verification -hide_title: false -draft: false -sidebar_label: Identity Verification -sidebar_position: 4 -tags: - - concepts - - terminology - - identity - - verification - - add - - document -keywords: - - concepts - - terminology - - identity - - verification - - add - - document -description: What is the Identity Verification in Deriv applications? ---- - -### What is the Identity Verification in Deriv applications? - -Adds document information such as issuing country, id and type for identity verification processes. diff --git a/docs/_terminology/account/_category_.json b/docs/_terminology/account/_category_.json deleted file mode 100644 index c682caa61..000000000 --- a/docs/_terminology/account/_category_.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "label": "Account", - "position": 1, - "link": { - "type": "generated-index", - "description": "Learn about our Account Category" - } -} diff --git a/docs/_terminology/account/document-upload/index.md b/docs/_terminology/account/document-upload/index.md deleted file mode 100644 index 48ce259b9..000000000 --- a/docs/_terminology/account/document-upload/index.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Document Upload -hide_title: false -draft: false -sidebar_label: Document Upload -sidebar_position: 4 -tags: - - concepts - - document - - upload - - terminology -keywords: - - concepts - - document - - upload - - terminology -description: What is the Document Upload API call? ---- - -### What is the Document Upload API call? - -Request KYC information from client diff --git a/docs/_terminology/account/financial-assessment-calls/_category_.json b/docs/_terminology/account/financial-assessment-calls/_category_.json deleted file mode 100644 index ab813b1be..000000000 --- a/docs/_terminology/account/financial-assessment-calls/_category_.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "label": "Financial Assessment calls", - "position": 1, - "link": { - "type": "generated-index", - "description": "Learn about our Financial Assessment API calls" - } -} diff --git a/docs/_terminology/account/financial-assessment-calls/get-financial-assessment/index.md b/docs/_terminology/account/financial-assessment-calls/get-financial-assessment/index.md deleted file mode 100644 index 586d7c9f7..000000000 --- a/docs/_terminology/account/financial-assessment-calls/get-financial-assessment/index.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: Get Financial Assessment -hide_title: false -draft: false -sidebar_label: Get Financial Assessment -sidebar_position: 4 -tags: - - concepts - - get - - financial - - assessment - - terminology -keywords: - - concepts - - get - - financial - - assessment - - terminology -description: What is the Get Financial Assessment API call? ---- - -### What is the Get Financial Assessment API call? - -This call gets the financial assessment details. - -The 'financial assessment' is a questionnaire that clients of certain Landing Companies need to complete, due to regulatory and KYC (know your client) requirements. diff --git a/docs/_terminology/account/financial-assessment-calls/set-financial-assessment/index.md b/docs/_terminology/account/financial-assessment-calls/set-financial-assessment/index.md deleted file mode 100644 index bd13109ce..000000000 --- a/docs/_terminology/account/financial-assessment-calls/set-financial-assessment/index.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: Set Financial Assessment -hide_title: false -draft: false -sidebar_label: Set Financial Assessment -sidebar_position: 4 -tags: - - concepts - - active-symbols -keywords: - - concepts - - active-symbols -description: What is the Set Financial Assessment API call? ---- - -### What is the Set Financial Assessment API call? - -This call sets the financial assessment details based on the client's answers to analyze whether they possess the experience and knowledge to understand the risks involved with binary options trading. diff --git a/docs/_terminology/account/get-account-settings/index.md b/docs/_terminology/account/get-account-settings/index.md deleted file mode 100644 index f4972a20b..000000000 --- a/docs/_terminology/account/get-account-settings/index.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: Get Account Settings -hide_title: false -draft: false -sidebar_label: Get Account Settings -sidebar_position: 4 -tags: - - concepts - - get - - account - - settings - - terminology -keywords: - - concepts - - get - - account - - settings - - terminology -description: What is the Get Account Settings API call? ---- - -### What is the Get Account Settings API call? - -Get User Settings (email, date of birth, address etc) diff --git a/docs/_terminology/account/portfolio/index.md b/docs/_terminology/account/portfolio/index.md deleted file mode 100644 index 85b4b0f36..000000000 --- a/docs/_terminology/account/portfolio/index.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: Portfolio -hide_title: false -draft: false -sidebar_label: Portfolio -sidebar_position: 4 -tags: - - concepts - - portfolio - - terminology -keywords: - - concepts - - portfolio - - terminology -description: What is the Portfolio API call? ---- - -### What is the Portfolio API call? - -Receive information about my current portfolio of outstanding options. diff --git a/docs/_terminology/account/profit-table/index.md b/docs/_terminology/account/profit-table/index.md deleted file mode 100644 index 231317bc4..000000000 --- a/docs/_terminology/account/profit-table/index.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Profit table -hide_title: false -draft: false -sidebar_label: Profit table -sidebar_position: 4 -tags: - - concepts - - profit - - table - - terminology -keywords: - - concepts - - profit - - table - - terminology -description: What is the Profit Table API call? ---- - -### What is the Profit Table API call? - -Retrieve a summary of account Profit Table, according to given search criteria. diff --git a/docs/_terminology/account/reality-check/index.md b/docs/_terminology/account/reality-check/index.md deleted file mode 100644 index 2ea4ab32b..000000000 --- a/docs/_terminology/account/reality-check/index.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: Reality Check -hide_title: false -draft: false -sidebar_label: Reality Check -sidebar_position: 4 -tags: - - concepts - - reality - - check - - terminology -keywords: - - concepts - - reality - - check - - terminology -description: What is the Reality Check API call? ---- - -### What is the Reality Check API call? - -Retrieve summary of client's trades and account for the Reality Check facility. - -A 'reality check' means a display of time elapsed since the session began, and associated client profit/loss. - -The Reality Check facility is a regulatory requirement for certain landing companies. diff --git a/docs/_terminology/account/statement/index.md b/docs/_terminology/account/statement/index.md deleted file mode 100644 index 748b4d47b..000000000 --- a/docs/_terminology/account/statement/index.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: Statement -hide_title: false -draft: false -sidebar_label: Statement -sidebar_position: 4 -tags: - - concepts - - statement - - terminology -keywords: - - concepts - - statement - - terminology -description: What is the Statement API call? ---- - -### What is the Statement API call? - -Retrieve a summary of account transactions, according to given search criteria. \ No newline at end of file diff --git a/docs/_terminology/account/virtual-vs-real-account/_category_.json b/docs/_terminology/account/virtual-vs-real-account/_category_.json deleted file mode 100644 index 05aff0409..000000000 --- a/docs/_terminology/account/virtual-vs-real-account/_category_.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "label": "Virtual / Real Account", - "position": 1, - "link": { - "type": "generated-index", - "description": "Learn about our Virtual and Real account API calls" - } -} diff --git a/docs/_terminology/contract/_category_.json b/docs/_terminology/contract/_category_.json deleted file mode 100644 index ab42cc88d..000000000 --- a/docs/_terminology/contract/_category_.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "label": "Contract", - "position": 2, - "link": { - "type": "generated-index", - "description": "Learn about our Contract Category" - } -} diff --git a/docs/_terminology/contract/buy-sell-contract-calls/_category_.json b/docs/_terminology/contract/buy-sell-contract-calls/_category_.json deleted file mode 100644 index 919d95aa8..000000000 --- a/docs/_terminology/contract/buy-sell-contract-calls/_category_.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "label": "Buy / Sell contract calls", - "position": 2, - "link": { - "type": "generated-index", - "description": "Learn about our buy and sell contract API calls" - } -} diff --git a/docs/_terminology/contract/buy-sell-contract-calls/buy-contract-multiple/index.md b/docs/_terminology/contract/buy-sell-contract-calls/buy-contract-multiple/index.md deleted file mode 100644 index b7995bc46..000000000 --- a/docs/_terminology/contract/buy-sell-contract-calls/buy-contract-multiple/index.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -title: Buy contract for multiple accounts -hide_title: false -draft: false -sidebar_label: Buy contract for multiple accounts -sidebar_position: 4 -tags: - - concepts - - buy - - contract - - multiple - - accounts - - terminology -keywords: - - concepts - - buy - - contract - - multiple - - accounts - - terminology -description: What is the Buy contract for multiple accounts API Call? ---- - -### What is the Buy contract for multiple accounts API Call? - -Buy a Contract for multiple Accounts specified by the `tokens` parameter. - -Note, although this is an authorized call, the contract is not bought for the authorized account. \ No newline at end of file diff --git a/docs/_terminology/contract/buy-sell-contract-calls/buy-contract/index.md b/docs/_terminology/contract/buy-sell-contract-calls/buy-contract/index.md deleted file mode 100644 index 3530f7263..000000000 --- a/docs/_terminology/contract/buy-sell-contract-calls/buy-contract/index.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Buy contract -hide_title: false -draft: false -sidebar_label: Buy contract -sidebar_position: 4 -tags: - - concepts - - buy - - contract - - terminology -keywords: - - concepts - - buy - - contract - - terminology -description: What is the Buy Contract API call? ---- - -### What is the Buy Contract API call? - -Buy a Contract. \ No newline at end of file diff --git a/docs/_terminology/contract/buy-sell-contract-calls/sell-contract-multiple/index.md b/docs/_terminology/contract/buy-sell-contract-calls/sell-contract-multiple/index.md deleted file mode 100644 index 892488359..000000000 --- a/docs/_terminology/contract/buy-sell-contract-calls/sell-contract-multiple/index.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: "Sell Contracts: Multiple Accounts" -hide_title: false -draft: false -sidebar_label: "Sell Contracts: Multiple Accounts" -sidebar_position: 4 -tags: - - concepts - - sell - - contract - - multiple - - accounts - - terminology -keywords: - - concepts - - sell - - contract - - multiple - - accounts - - terminology -description: "What is the Sell Contracts: Multiple Accounts API call?" ---- - -### What is the Sell Contracts: Multiple Accounts API call? - -Sell contracts for multiple accounts simultaneously. - -Uses the shortcode response from `buy_contract_for_multiple_accounts` to identify the contract, and authorisation tokens to select which accounts to sell those contracts on. - -Note that only the accounts identified by the tokens will be affected. This will not sell the contract on the currently-authorised account unless you include the token for the current account. \ No newline at end of file diff --git a/docs/_terminology/contract/buy-sell-contract-calls/sell-contract/index.md b/docs/_terminology/contract/buy-sell-contract-calls/sell-contract/index.md deleted file mode 100644 index 2c6e59bee..000000000 --- a/docs/_terminology/contract/buy-sell-contract-calls/sell-contract/index.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Sell Contract -hide_title: false -draft: false -sidebar_label: Sell Contract -sidebar_position: 4 -tags: - - concepts - - sell - - contract - - terminology -keywords: - - concepts - - sell - - contract - - terminology -description: What is the Sell Contract API call? ---- - -### What is the Sell Contract API call? - -Sell a Contract as identified from a previous `portfolio` call. diff --git a/docs/_terminology/contract/contracts-for-symbol/index.md b/docs/_terminology/contract/contracts-for-symbol/index.md deleted file mode 100644 index 144f23ae7..000000000 --- a/docs/_terminology/contract/contracts-for-symbol/index.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Contracts for symbol -hide_title: false -draft: false -sidebar_label: Contracts for symbol -sidebar_position: 4 -tags: - - concepts - - contracts - - symbol - - terminology -keywords: - - concepts - - contracts - - symbol - - terminology -description: What is the Contracts for symbol API call? ---- - -### What is the Contracts for symbol API call? - -For a given symbol, get the list of currently available contracts, and the latest barrier and duration limits for each contract. diff --git a/docs/_terminology/contract/price-proposal-calls/_category_.json b/docs/_terminology/contract/price-proposal-calls/_category_.json deleted file mode 100644 index a7930791e..000000000 --- a/docs/_terminology/contract/price-proposal-calls/_category_.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "label": "Price Proposal calls", - "position": 2, - "link": { - "type": "generated-index", - "description": "Learn about our Price Proposal API calls" - } -} diff --git a/docs/_terminology/contract/price-proposal-calls/price-proposal-open-contracts/index.md b/docs/_terminology/contract/price-proposal-calls/price-proposal-open-contracts/index.md deleted file mode 100644 index 3707d312a..000000000 --- a/docs/_terminology/contract/price-proposal-calls/price-proposal-open-contracts/index.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: "Price Proposal: Open Contracts" -hide_title: false -draft: false -sidebar_label: "Price Proposal: Open Contracts" -sidebar_position: 4 -tags: - - concepts - - price - - proposal - - open - - contracts - - terminology -keywords: - - concepts - - price - - proposal - - open - - contracts - - terminology -description: "What is the Price Proposal: Open Contracts API call?" ---- - -### What is the Price Proposal: Open Contracts API call? - -Gets latest price for a specific contract. diff --git a/docs/_terminology/contract/price-proposal-calls/price-proposal/index.md b/docs/_terminology/contract/price-proposal-calls/price-proposal/index.md deleted file mode 100644 index cc5d4dde0..000000000 --- a/docs/_terminology/contract/price-proposal-calls/price-proposal/index.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Price proposal -hide_title: false -draft: false -sidebar_label: Price proposal -sidebar_position: 4 -tags: - - concepts - - price - - proposal - - terminology -keywords: - - concepts - - price - - proposal - - terminology -description: What is the Price proposal API call? ---- - -### What is the Price proposal API call? - -Gets latest price for a specific contract. diff --git a/docs/_terminology/contract/sell-expired-contracts/index.md b/docs/_terminology/contract/sell-expired-contracts/index.md deleted file mode 100644 index e3bd2fd3f..000000000 --- a/docs/_terminology/contract/sell-expired-contracts/index.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: Sell Expired Contracts -hide_title: false -draft: false -sidebar_label: Sell Expired Contracts -sidebar_position: 4 -tags: - - concepts - - sell - - expired - - contracts - - terminology -keywords: - - concepts - - sell - - expired - - contracts - - terminology -description: What is the Buy Contract API call? ---- - -### What is the Sell Expired Contracts API call? - -This call will try to sell any expired contracts and return the number of sold contracts. diff --git a/docs/_terminology/copy-trading/_category_.json b/docs/_terminology/copy-trading/_category_.json deleted file mode 100644 index 87e41b855..000000000 --- a/docs/_terminology/copy-trading/_category_.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "label": "Copy Trading", - "position": 1, - "link": { - "type": "generated-index", - "description": "Learn about our Copy Trading API calls" - } -} diff --git a/docs/_terminology/copy-trading/copy-trading-list/index.md b/docs/_terminology/copy-trading/copy-trading-list/index.md deleted file mode 100644 index 6a4071039..000000000 --- a/docs/_terminology/copy-trading/copy-trading-list/index.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: "Copy Trading: List" -hide_title: false -draft: false -sidebar_label: "Copy Trading: List" -sidebar_position: 4 -tags: - - P2P - - copy - - trading - - list - - concepts - - terminology -keywords: - - P2P - - copy - - trading - - list - - concepts - - terminology -description: "What is the Copy Trading: List API call?" ---- - -### What is the Copy Trading: List API call? - -Retrieves a list of active copiers and/or traders for Copy Trading diff --git a/docs/_terminology/copy-trading/copy-trading-start/index.md b/docs/_terminology/copy-trading/copy-trading-start/index.md deleted file mode 100644 index 4219c14e9..000000000 --- a/docs/_terminology/copy-trading/copy-trading-start/index.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: "Copy Trading: Start" -hide_title: false -draft: false -sidebar_label: "Copy Trading: Start" -sidebar_position: 4 -tags: - - P2P - - copy - - trading - - start - - concepts - - terminology -keywords: - - P2P - - copy - - trading - - start - - concepts - - terminology -description: "What is the Copy Trading: Start API call?" ---- - -### What is the Copy Trading: Start API call? - -Start copy trader bets. diff --git a/docs/_terminology/copy-trading/copy-trading-statistics/index.md b/docs/_terminology/copy-trading/copy-trading-statistics/index.md deleted file mode 100644 index 066aa993f..000000000 --- a/docs/_terminology/copy-trading/copy-trading-statistics/index.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: "Copy Trading: Statistics" -hide_title: false -draft: false -sidebar_label: "Copy Trading: Statistics" -sidebar_position: 4 -tags: - - P2P - - copy - - trading - - statistics - - concepts - - terminology -keywords: - - P2P - - copy - - trading - - statistics - - concepts - - terminology -description: "What is the Copy Trading: Statistics API call?" ---- - -### What is the Copy Trading: Statistics API call? - -Retrieve performance, trading, risk and copiers statistics of trader. diff --git a/docs/_terminology/copy-trading/copy-trading-stop/index.md b/docs/_terminology/copy-trading/copy-trading-stop/index.md deleted file mode 100644 index c5e8290a3..000000000 --- a/docs/_terminology/copy-trading/copy-trading-stop/index.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: "Copy Trading: Stop" -hide_title: false -draft: false -sidebar_label: "Copy Trading: Stop" -sidebar_position: 4 -tags: - - P2P - - copy - - trading - - stop - - concepts - - terminology -keywords: - - P2P - - copy - - trading - - stop - - concepts - - terminology -description: "What is the Copy Trading: Stop API call?" ---- - -### What is the Copy Trading: Stop API call? - -Start copy trader bets. diff --git a/docs/_terminology/p2p/_category_.json b/docs/_terminology/p2p/_category_.json deleted file mode 100644 index ebe80fe74..000000000 --- a/docs/_terminology/p2p/_category_.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "label": "P2P", - "position": 6, - "link": { - "type": "generated-index", - "description": "Learn about our P2P Category" - } -} diff --git a/docs/_terminology/p2p/p2p-advertisement/_category_.json b/docs/_terminology/p2p/p2p-advertisement/_category_.json deleted file mode 100644 index f716e8d43..000000000 --- a/docs/_terminology/p2p/p2p-advertisement/_category_.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "label": "P2P Advertisement calls", - "position": 6, - "link": { - "type": "generated-index", - "description": "Learn about our P2P Advertisements API calls" - } -} diff --git a/docs/_terminology/p2p/p2p-advertisement/p2p-advert-create/index.md b/docs/_terminology/p2p/p2p-advertisement/p2p-advert-create/index.md deleted file mode 100644 index 5f70bdd98..000000000 --- a/docs/_terminology/p2p/p2p-advertisement/p2p-advert-create/index.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: P2P Advert Create -hide_title: false -draft: false -sidebar_label: P2P Advert Create -sidebar_position: 4 -tags: - - concepts - - p2p - - advert - - create - - terminology -keywords: - - concepts - - p2p - - advert - - create - - terminology -description: What is the P2P Advert Create API call? ---- - -### What is the P2P Advert Create API call? - -Creates a P2P (Peer to Peer) advert. Can only be used by an approved P2P advertiser. diff --git a/docs/_terminology/p2p/p2p-advertisement/p2p-advert-information/index.md b/docs/_terminology/p2p/p2p-advertisement/p2p-advert-information/index.md deleted file mode 100644 index 4ea4188c0..000000000 --- a/docs/_terminology/p2p/p2p-advertisement/p2p-advert-information/index.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: P2P Advert Information -hide_title: false -draft: false -sidebar_label: P2P Advert Information -sidebar_position: 4 -tags: - - concepts - - p2p - - advert - - information - - terminology -keywords: - - concepts - - p2p - - advert - - information - - terminology -description: What is the P2P Advert Information API call? ---- - -### What is the P2P Advert Information API call? - -Retrieve information about a P2P advert. diff --git a/docs/_terminology/p2p/p2p-advertisement/p2p-advert-list/index.md b/docs/_terminology/p2p/p2p-advertisement/p2p-advert-list/index.md deleted file mode 100644 index 80b6907ac..000000000 --- a/docs/_terminology/p2p/p2p-advertisement/p2p-advert-list/index.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: P2P Advert List -hide_title: false -draft: false -sidebar_label: P2P Advert List -sidebar_position: 4 -tags: - - concepts - - p2p - - advert - - List - - terminology -keywords: - - concepts - - p2p - - advert - - List - - terminology -description: What is the P2P Advert List API call? ---- - -### What is the P2P Advert List API call? - -Returns available adverts for use with `p2p_order_create` diff --git a/docs/_terminology/p2p/p2p-advertisement/p2p-advert-update/index.md b/docs/_terminology/p2p/p2p-advertisement/p2p-advert-update/index.md deleted file mode 100644 index 8e22da969..000000000 --- a/docs/_terminology/p2p/p2p-advertisement/p2p-advert-update/index.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: P2P Advert Update -hide_title: false -draft: false -sidebar_label: P2P Advert Update -sidebar_position: 4 -tags: - - concepts - - p2p - - advert - - update - - terminology -keywords: - - concepts - - p2p - - advert - - update - - terminology -description: What is the P2P Advert Update API call? ---- - -### What is the P2P Advert Update API call? - -Updates a P2P advert. Can only be used by the advertiser. diff --git a/docs/_terminology/p2p/p2p-advertiser/_category_.json b/docs/_terminology/p2p/p2p-advertiser/_category_.json deleted file mode 100644 index f2ea7885e..000000000 --- a/docs/_terminology/p2p/p2p-advertiser/_category_.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "label": "P2P Advertiser calls", - "position": 6, - "link": { - "type": "generated-index", - "description": "Learn about our P2P advertiser API calls" - } -} diff --git a/docs/_terminology/p2p/p2p-advertiser/p2p-advertiser-advert/index.md b/docs/_terminology/p2p/p2p-advertiser/p2p-advertiser-advert/index.md deleted file mode 100644 index 5828919a3..000000000 --- a/docs/_terminology/p2p/p2p-advertiser/p2p-advertiser-advert/index.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: P2P Advertiser Adverts -hide_title: false -draft: false -sidebar_label: P2P Advertiser Adverts -sidebar_position: 4 -tags: - - concepts - - p2p - - advert - - advertiser - - terminology -keywords: - - concepts - - p2p - - advert - - advertiser - - terminology -description: What is the P2P Advertiser Adverts API call? ---- - -### What is the P2P Advertiser Adverts API call? - -Returns all P2P adverts created by the authorized client. Can only be used by a registered P2P advertiser. diff --git a/docs/_terminology/p2p/p2p-advertiser/p2p-advertiser-create/index.md b/docs/_terminology/p2p/p2p-advertiser/p2p-advertiser-create/index.md deleted file mode 100644 index 5d9b4aa36..000000000 --- a/docs/_terminology/p2p/p2p-advertiser/p2p-advertiser-create/index.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: P2P Advertiser Create -hide_title: false -draft: false -sidebar_label: P2P Advertiser Create -sidebar_position: 4 -tags: - - concepts - - p2p - - create - - advertiser - - terminology -keywords: - - concepts - - p2p - - create - - advertiser - - terminology -description: What is the P2P Advertiser Create API call? ---- - -### What is the P2P Advertiser Create API call? - -Registers the client as a P2P advertiser. diff --git a/docs/_terminology/p2p/p2p-advertiser/p2p-advertiser-information/index.md b/docs/_terminology/p2p/p2p-advertiser/p2p-advertiser-information/index.md deleted file mode 100644 index 7897c7e9e..000000000 --- a/docs/_terminology/p2p/p2p-advertiser/p2p-advertiser-information/index.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: P2P Advertiser Information -hide_title: false -draft: false -sidebar_label: P2P Advertiser Information -sidebar_position: 4 -tags: - - P2P - - advertiser - - information - - concepts - - terminology -keywords: - - P2P - - advertiser - - information - - concepts - - terminology -description: What is the P2P Advertiser Information API call? ---- - -### What is the P2P Advertiser Information API call? - -Retrieve information about a P2P advertiser. diff --git a/docs/_terminology/p2p/p2p-advertiser/p2p-advertiser-payment-methods/index.md b/docs/_terminology/p2p/p2p-advertiser/p2p-advertiser-payment-methods/index.md deleted file mode 100644 index f22fc870e..000000000 --- a/docs/_terminology/p2p/p2p-advertiser/p2p-advertiser-payment-methods/index.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: P2P Advertiser Payment Methods -hide_title: false -draft: false -sidebar_label: P2P Advertiser Payment Methods -sidebar_position: 4 -tags: - - P2P - - payment - - advertiser - - methods - - concepts - - terminology -keywords: - - P2P - - payment - - advertiser - - methods - - concepts - - terminology -description: What is the P2P Advertiser Payment Methods API call? ---- - -### What is the P2P Advertiser Payment Methods API call? - -Manage or list P2P advertiser payment methods. diff --git a/docs/_terminology/p2p/p2p-advertiser/p2p-advertiser-relations/index.md b/docs/_terminology/p2p/p2p-advertiser/p2p-advertiser-relations/index.md deleted file mode 100644 index d5ff923dd..000000000 --- a/docs/_terminology/p2p/p2p-advertiser/p2p-advertiser-relations/index.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: P2P Advertiser Relations -hide_title: false -draft: false -sidebar_label: P2P Advertiser Relations -sidebar_position: 4 -tags: - - P2P - - advertiser - - relations - - concepts - - terminology -keywords: - - P2P - - advertiser - - relations - - concepts - - terminology -description: What is the P2P Advertiser Relations API call? ---- - -### What is the P2P Advertiser Relations API call? - -Updates and returns favourite and blocked advertisers of the current user. diff --git a/docs/_terminology/p2p/p2p-advertiser/p2p-advertiser-update/index.md b/docs/_terminology/p2p/p2p-advertiser/p2p-advertiser-update/index.md deleted file mode 100644 index b307f9bdd..000000000 --- a/docs/_terminology/p2p/p2p-advertiser/p2p-advertiser-update/index.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: P2P Advertiser Update -hide_title: false -draft: false -sidebar_label: P2P Advertiser Update -sidebar_position: 4 -tags: - - P2P - - advertiser - - update - - concepts - - terminology -keywords: - - P2P - - advertiser - - update - - concepts - - terminology -description: What is the P2P Advertiser Update API call? ---- - -### What is the P2P Advertiser Update API call? - -Update the information of the P2P advertiser for the current account. Can only be used by an approved P2P advertiser. diff --git a/docs/_terminology/p2p/p2p-order/_category_.json b/docs/_terminology/p2p/p2p-order/_category_.json deleted file mode 100644 index 15c0f5d41..000000000 --- a/docs/_terminology/p2p/p2p-order/_category_.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "label": "P2P Order calls", - "position": 6, - "link": { - "type": "generated-index", - "description": "Learn about our P2P Order calls" - } -} diff --git a/docs/_terminology/p2p/p2p-order/p2p-order-cancel/index.md b/docs/_terminology/p2p/p2p-order/p2p-order-cancel/index.md deleted file mode 100644 index 6abcbb128..000000000 --- a/docs/_terminology/p2p/p2p-order/p2p-order-cancel/index.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: P2P Order Cancel -hide_title: false -draft: false -sidebar_label: P2P Order Cancel -sidebar_position: 4 -tags: - - P2P - - cancel - - order - - concepts - - terminology -keywords: - - P2P - - cancel - - order - - concepts - - terminology -description: What is the P2P Order Cancel API call? ---- - -### What is the P2P Order Cancel API call? - -Cancel a P2P order. diff --git a/docs/_terminology/p2p/p2p-order/p2p-order-confirm/index.md b/docs/_terminology/p2p/p2p-order/p2p-order-confirm/index.md deleted file mode 100644 index 50b546813..000000000 --- a/docs/_terminology/p2p/p2p-order/p2p-order-confirm/index.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: P2P Order Confirm -hide_title: false -draft: false -sidebar_label: P2P Order Confirm -sidebar_position: 4 -tags: - - P2P - - confirm - - order - - concepts - - terminology -keywords: - - P2P - - confirm - - order - - concepts - - terminology -description: What is the P2P Order Confirm API call? ---- - -### What is the P2P Order Confirm API call? - -Confirm a P2P order. diff --git a/docs/_terminology/p2p/p2p-order/p2p-order-create/index.md b/docs/_terminology/p2p/p2p-order/p2p-order-create/index.md deleted file mode 100644 index 7d62b7bbe..000000000 --- a/docs/_terminology/p2p/p2p-order/p2p-order-create/index.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: P2P Order Create -hide_title: false -draft: false -sidebar_label: P2P Order Create -sidebar_position: 4 -tags: - - P2P - - create - - order - - concepts - - terminology -keywords: - - P2P - - create - - order - - concepts - - terminology -description: What is the P2P Order Create API call? ---- - -### What is the P2P Order Create API call? - -Creates a P2P order for the specified advert. diff --git a/docs/_terminology/p2p/p2p-order/p2p-order-dispute/index.md b/docs/_terminology/p2p/p2p-order/p2p-order-dispute/index.md deleted file mode 100644 index 5e3d5aabf..000000000 --- a/docs/_terminology/p2p/p2p-order/p2p-order-dispute/index.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: P2P Order Dispute -hide_title: false -draft: false -sidebar_label: P2P Order Dispute -sidebar_position: 4 -tags: - - concepts - - p2p - - order - - dispute - - terminology -keywords: - - concepts - - p2p - - order - - dispute - - terminology -description: What is the P2P Order Dispute API call? ---- - -### What is the P2P Order Dispute API call? - -Dispute a P2P order. diff --git a/docs/_terminology/p2p/p2p-order/p2p-order-information/index.md b/docs/_terminology/p2p/p2p-order/p2p-order-information/index.md deleted file mode 100644 index 065dc9c7f..000000000 --- a/docs/_terminology/p2p/p2p-order/p2p-order-information/index.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: P2P Order Information -hide_title: false -draft: false -sidebar_label: P2P Order Information -sidebar_position: 4 -tags: - - concepts - - p2p - - order - - information - - terminology -keywords: - - concepts - - p2p - - order - - information - - terminology -description: What is the P2P Order Information API call? ---- - -### What is the P2P Order Information API call? - -Retrieves the information about a P2P order. diff --git a/docs/_terminology/p2p/p2p-order/p2p-order-list/index.md b/docs/_terminology/p2p/p2p-order/p2p-order-list/index.md deleted file mode 100644 index 23f7fa920..000000000 --- a/docs/_terminology/p2p/p2p-order/p2p-order-list/index.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: P2P Order List -hide_title: false -draft: false -sidebar_label: P2P Order List -sidebar_position: 4 -tags: - - concepts - - p2p - - order - - list - - terminology -keywords: - - concepts - - p2p - - order - - list - - terminology -description: What is the P2P Order List API call? ---- - -### What is the P2P Order List API call? - -List active orders. diff --git a/docs/_terminology/p2p/p2p-order/p2p-order-review/index.md b/docs/_terminology/p2p/p2p-order/p2p-order-review/index.md deleted file mode 100644 index af502599d..000000000 --- a/docs/_terminology/p2p/p2p-order/p2p-order-review/index.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: P2P Order Review -hide_title: false -draft: false -sidebar_label: P2P Order Review -sidebar_position: 4 -tags: - - concepts - - p2p - - order - - review - - terminology -keywords: - - concepts - - p2p - - order - - review - - terminology -description: What is the P2P Order Review API call? ---- - -### What is the P2P Order Review API call? - -Creates a review for the specified order. diff --git a/docs/_terminology/payment/_category_.json b/docs/_terminology/payment/_category_.json deleted file mode 100644 index 16fb97a81..000000000 --- a/docs/_terminology/payment/_category_.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "label": "Payment", - "position": 4, - "link": { - "type": "generated-index", - "description": "Learn about our Payment Category" - } -} diff --git a/docs/_terminology/payment/cashier-information/index.md b/docs/_terminology/payment/cashier-information/index.md deleted file mode 100644 index 5ca3cfd1f..000000000 --- a/docs/_terminology/payment/cashier-information/index.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Cashier information -hide_title: false -draft: false -sidebar_label: Cashier information -sidebar_position: 4 -tags: - - concepts - - cashier - - information - - terminology -keywords: - - concepts - - cashier - - information - - terminology -description: What is the Cashier information API call? ---- - -### What is the Cashier information API call? - -Request the cashier info for the specified type. diff --git a/docs/_terminology/payment/payment-agent/_category_.json b/docs/_terminology/payment/payment-agent/_category_.json deleted file mode 100644 index efa0ff4e8..000000000 --- a/docs/_terminology/payment/payment-agent/_category_.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "label": "Payment Agent calls", - "position": 1, - "link": { - "type": "generated-index", - "description": "Learn about our Payment Agent calls" - } -} diff --git a/docs/_terminology/payment/payment-agent/payment-agent-create/index.md b/docs/_terminology/payment/payment-agent/payment-agent-create/index.md deleted file mode 100644 index 91cade5e7..000000000 --- a/docs/_terminology/payment/payment-agent/payment-agent-create/index.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: Payment agent create -hide_title: false -draft: false -sidebar_label: Payment agent create -sidebar_position: 4 -tags: - - concepts - - payment - - agent - - create - - terminology -keywords: - - concepts - - payment - - agent - - create - - terminology -description: What is the Payment agent create API call? ---- - -### What is the Payment agent create API call? - -Saves client's payment agent details. diff --git a/docs/_terminology/payment/payment-agent/payment-agent-details/index.md b/docs/_terminology/payment/payment-agent/payment-agent-details/index.md deleted file mode 100644 index 01db3d92d..000000000 --- a/docs/_terminology/payment/payment-agent/payment-agent-details/index.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: Payment agent details -hide_title: false -draft: false -sidebar_label: Payment agent details -sidebar_position: 4 -tags: - - concepts - - payment - - agent - - details - - terminology -keywords: - - concepts - - payment - - agent - - details - - terminology -description: What is the Payment agent details API call? ---- - -### What is the Payment agent details API call? - -Gets client's payment agent details. diff --git a/docs/_terminology/payment/payment-agent/payment-agent-list/index.md b/docs/_terminology/payment/payment-agent/payment-agent-list/index.md deleted file mode 100644 index 49284e22c..000000000 --- a/docs/_terminology/payment/payment-agent/payment-agent-list/index.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: "Payment Agent: List" -hide_title: false -draft: false -sidebar_label: "Payment Agent: List" -sidebar_position: 4 -tags: - - concepts - - payment - - agent - - list - - terminology -keywords: - - concepts - - payment - - agent - - list - - terminology -description: "What is the Payment Agent: List API call?" ---- - -### What is the Payment Agent: List API call? - -Will return a list of Payment Agents for a given country for a given currency. - -Payment agents allow users to deposit and withdraw funds using local payment methods that might not be available via the main website's cashier system. diff --git a/docs/_terminology/payment/payment-agent/payment-agent-transfer/index.md b/docs/_terminology/payment/payment-agent/payment-agent-transfer/index.md deleted file mode 100644 index 4166802be..000000000 --- a/docs/_terminology/payment/payment-agent/payment-agent-transfer/index.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: "Payment Agent: Transfer" -hide_title: false -draft: false -sidebar_label: "Payment Agent: Transfer" -sidebar_position: 4 -tags: - - concepts - - payment - - agent - - transfer - - terminology -keywords: - - concepts - - payment - - agent - - transfer - - terminology -description: "What is the Payment Agent: Transfer API call?" ---- - -### What is the Payment Agent: Transfer API call? - -Payment Agent Transfer - this call is available only to accounts that are approved Payment Agents. diff --git a/docs/_terminology/payment/payment-agent/payment-agent-withdraw/index.md b/docs/_terminology/payment/payment-agent/payment-agent-withdraw/index.md deleted file mode 100644 index fe5250980..000000000 --- a/docs/_terminology/payment/payment-agent/payment-agent-withdraw/index.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: "Payment Agent: Withdraw" -hide_title: false -draft: false -sidebar_label: "Payment Agent: Withdraw" -sidebar_position: 4 -tags: - - concepts - - payment - - agent - - withdraw - - terminology -keywords: - - concepts - - payment - - agent - - withdraw - - terminology -description: "What is the Payment Agent: Withdraw API call?" ---- - -### What is the Payment Agent: Withdraw API call? - -Initiate a withdrawal to an approved Payment Agent. \ No newline at end of file diff --git a/docs/_terminology/payment/payment-methods/index.md b/docs/_terminology/payment/payment-methods/index.md deleted file mode 100644 index c06354713..000000000 --- a/docs/_terminology/payment/payment-methods/index.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Payment Methods -hide_title: false -draft: false -sidebar_label: Payment Methods -sidebar_position: 4 -tags: - - concepts - - payment - - methods - - terminology -keywords: - - concepts - - payment - - methods - - terminology -description: What is the Payment Methods API call? ---- - -### What is the Payment Methods API call? - -Will return a list payment methods available for the given country. If the request is authenticated the client's residence country will be used. diff --git a/docs/_terminology/trading/_category_.json b/docs/_terminology/trading/_category_.json deleted file mode 100644 index 96dae70f0..000000000 --- a/docs/_terminology/trading/_category_.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "label": "Trading", - "position": 3, - "link": { - "type": "generated-index", - "description": "Learn about our Trading Category" - } -} diff --git a/docs/_terminology/trading/active-symbols/index.md b/docs/_terminology/trading/active-symbols/index.md deleted file mode 100644 index 49b562fe9..000000000 --- a/docs/_terminology/trading/active-symbols/index.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Active symbols -hide_title: false -draft: false -sidebar_label: Active symbols -sidebar_position: 4 -tags: - - concepts - - active - - symbols - - terminology -keywords: - - concepts - - active - - symbols - - terminology -description: What is the Active symbols API call? ---- - -### What is the Active symbols API call? - -Retrieve a list of all currently active symbols (underlying markets upon which contracts are available for trading). diff --git a/docs/_terminology/trading/asset-index/index.md b/docs/_terminology/trading/asset-index/index.md deleted file mode 100644 index cf4899ceb..000000000 --- a/docs/_terminology/trading/asset-index/index.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: Asset index -hide_title: false -draft: false -sidebar_label: Asset index -sidebar_position: 4 -tags: - - concepts - - asset - - index - - terminology -keywords: - - concepts - - asset - - index - - terminology -description: What is the Asset index API call? ---- - -### What is the Asset index API call? - -Retrieve a list of all available underlyings and the corresponding contract types and duration boundaries. - -If the user is logged in, only the assets available for that user's landing company will be returned. diff --git a/docs/_terminology/trading/landing-company-calls/_category_.json b/docs/_terminology/trading/landing-company-calls/_category_.json deleted file mode 100644 index 8701fdea6..000000000 --- a/docs/_terminology/trading/landing-company-calls/_category_.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "label": "Landing Company calls", - "position": 2, - "link": { - "type": "generated-index", - "description": "Learn about our Landing Company API calls" - } -} diff --git a/docs/_terminology/trading/landing-company-calls/landing-company-details/index.md b/docs/_terminology/trading/landing-company-calls/landing-company-details/index.md deleted file mode 100644 index 0ede5a463..000000000 --- a/docs/_terminology/trading/landing-company-calls/landing-company-details/index.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: Landing company details -hide_title: false -draft: false -sidebar_label: Landing company details -sidebar_position: 4 -tags: - - concepts - - landing - - company - - details - - terminology -keywords: - - concepts - - landing - - company - - details - - terminology -description: What is the Landing company details API call? ---- - -### What is the Landing company details API call? - -The company has a number of licensed subsidiaries in various jurisdictions, which are called Landing Companies (and which are wholly owned subsidiaries of the Deriv Group). - -This call provides information about each Landing Company. diff --git a/docs/_terminology/trading/landing-company-calls/landing-company/index.md b/docs/_terminology/trading/landing-company-calls/landing-company/index.md deleted file mode 100644 index 0d912a726..000000000 --- a/docs/_terminology/trading/landing-company-calls/landing-company/index.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: Landing company -hide_title: false -draft: false -sidebar_label: Landing company -sidebar_position: 4 -tags: - - concepts - - landing - - company - - terminology -keywords: - - concepts - - landing - - company - - terminology -description: What is the Landing company API call? ---- - -### What is the Landing company API call? - -The company has a number of licensed subsidiaries in various jurisdictions, which are called Landing Companies. - -This call will return the appropriate Landing Company for clients of a given country. - -The landing company may differ for Synthetic Indices and Financial contracts (Forex, Stock Indices, Commodities). diff --git a/docs/_terminology/trading/residence-list/index.md b/docs/_terminology/trading/residence-list/index.md deleted file mode 100644 index 8dafda65b..000000000 --- a/docs/_terminology/trading/residence-list/index.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -title: Countries List -hide_title: false -draft: false -sidebar_label: Countries List -sidebar_position: 2 -tags: - - concepts - - countries - - resident - - list - - terminology -keywords: - - concepts - - countries - - resident - - list - - terminology -description: what is the Countries List API call? ---- - -### What is the Countries List API call? - -List of countries and 2-letter country codes, suitable for populating the account opening form. - -the example list can be something like so: - -```json -[ - { - "identity": { - "services": { - "idv": { - "documents_supported": {}, - "has_visual_sample": 0, - "is_country_supported": 0 - }, - "onfido": { - "documents_supported": { - "passport": { - "display_name": "Passport" - } - }, - "is_country_supported": 0 - } - } - }, - "phone_idd": "93", - "text": "Afghanistan", - "value": "af" - }, - { - "identity": { - "services": { - "idv": { - "documents_supported": {}, - "has_visual_sample": 0, - "is_country_supported": 0 - }, - "onfido": { - "documents_supported": {}, - "is_country_supported": 0 - } - } - }, - "phone_idd": "35818", - "text": "Aland Islands", - "value": "ax" - } -] -``` - -You can read more about the `Countries List` on [API Explorer - Countries List](https://api.deriv.com/api-explorer#residence_list) \ No newline at end of file diff --git a/docs/_terminology/trading/tick/_category_.json b/docs/_terminology/trading/tick/_category_.json deleted file mode 100644 index bdd79fd50..000000000 --- a/docs/_terminology/trading/tick/_category_.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "label": "Tick calls", - "position": 1, - "link": { - "type": "generated-index", - "description": "Learn about our Tick API calls" - } -} diff --git a/docs/_terminology/trading/tick/ticks-history/index.md b/docs/_terminology/trading/tick/ticks-history/index.md deleted file mode 100644 index 41e612a38..000000000 --- a/docs/_terminology/trading/tick/ticks-history/index.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Ticks History -hide_title: false -draft: false -sidebar_label: Ticks History -sidebar_position: 4 -tags: - - concepts - - ticks - - history - - terminology -keywords: - - concepts - - ticks - - history - - terminology -description: What is the Ticks History API call? ---- - -### What is the Ticks History API call? - -Get historic tick data for a given symbol. diff --git a/docs/_terminology/trading/tick/ticks-stream/index.md b/docs/_terminology/trading/tick/ticks-stream/index.md deleted file mode 100644 index dfcb10f79..000000000 --- a/docs/_terminology/trading/tick/ticks-stream/index.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Ticks Stream -hide_title: false -draft: false -sidebar_label: Ticks Stream -sidebar_position: 4 -tags: - - concepts - - ticks - - stream - - terminology -keywords: - - concepts - - ticks - - stream - - terminology -description: What is the Ticks Stream API call? ---- - -### What is the Ticks Stream API call? - -Initiate a continuous stream of spot price updates for a given symbol. diff --git a/docs/_terminology/trading/trading-durations/index.md b/docs/_terminology/trading/trading-durations/index.md deleted file mode 100644 index c8695b22f..000000000 --- a/docs/_terminology/trading/trading-durations/index.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: Trading Durations -hide_title: false -draft: false -sidebar_label: Trading Durations -sidebar_position: 4 -tags: - - concepts - - asset - - index - - terminology -keywords: - - concepts - - asset - - index - - terminology -description: What is the Trading Durations API call? ---- - -### What is the Trading Durations API call? - -Retrieve a list of all available underlyings and the corresponding contract types and trading duration boundaries. - -If the user is logged in, only the assets available for that user's landing company will be returned. \ No newline at end of file diff --git a/docs/code-examples/_category_.json b/docs/code-examples/_category_.json deleted file mode 100644 index 80199a9cc..000000000 --- a/docs/code-examples/_category_.json +++ /dev/null @@ -1,9 +0,0 @@ -{ - "label": "Code examples", - "position": 3, - "link": { - "type": "generated-index", - "title": "Code examples", - "description": "Find out which API codes are available for you to use to build your trading app. Learn with API examples." - } -} diff --git a/docs/code-examples/javascript/_category_.json b/docs/code-examples/javascript/_category_.json deleted file mode 100644 index e963278db..000000000 --- a/docs/code-examples/javascript/_category_.json +++ /dev/null @@ -1,9 +0,0 @@ -{ - "label": "Javascript Examples", - "position": 1, - "link": { - "type": "generated-index", - "description": "Explore JavaScript codes you can use to build your trading app. Learn through JavaScript examples and API examples.", - "title": "JavaScript examples" - } -} diff --git a/docs/code-examples/javascript/active-symbols/index.mdx b/docs/code-examples/javascript/active-symbols/index.mdx deleted file mode 100644 index e22ef7e41..000000000 --- a/docs/code-examples/javascript/active-symbols/index.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: Active symbols -draft: false -sidebar_label: Active Symbols -sidebar_position: 3 -tags: - - code - - example - - active - - symbols -keywords: - - code - - example - - active - - symbols -description: Learn how to add active symbols and market information to your trading app with an API example. ---- - -import SandboxIframe from '@site/src/components/SandboxIframe'; -import { sandboxes } from '@site/src/components/SandboxIframe/utility/sandboxes'; - -Retrieve a list of all currently active symbols (underlying markets upon which contracts are available for trading). - - - -The data contains market and submarket information related to the symbol. In case you want to retrieve active symbols for a specific landing company, you can add landing_company to the request object. diff --git a/docs/code-examples/javascript/contracts-for-symbol/index.mdx b/docs/code-examples/javascript/contracts-for-symbol/index.mdx deleted file mode 100644 index bf45b6005..000000000 --- a/docs/code-examples/javascript/contracts-for-symbol/index.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: Contracts for symbols -draft: false -sidebar_label: Contracts for Symbol -sidebar_position: 4 -tags: - - code - - example - - contracts - - symbol -keywords: - - code - - example - - contracts - - symbol -description: Add a list of market symbols and their latest barrier and duration limits to your trading app with this API example. ---- - -import SandboxIframe from '@site/src/components/SandboxIframe'; -import { sandboxes } from '@site/src/components/SandboxIframe/utility/sandboxes'; - -For a given symbol, get the list of currently available contracts, and the latest barrier and duration limits for each contract. - - diff --git a/docs/code-examples/javascript/keep-alive/index.mdx b/docs/code-examples/javascript/keep-alive/index.mdx deleted file mode 100644 index 555d0e08c..000000000 --- a/docs/code-examples/javascript/keep-alive/index.mdx +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: Contract proposal connection -draft: false -sidebar_label: Keep Alive -sidebar_position: 7 -tags: - - code - - example - - keep - - alive -keywords: - - code - - example - - keep - - alive -description: With this API example, learn how to keep a connection alive when getting contract proposals via the Deriv API. ---- - -import RenderOfficialContents from '@site/src/components/RenderOfficialContents'; -import SandboxIframe from '@site/src/components/SandboxIframe'; -import { sandboxes } from '@site/src/components/SandboxIframe/utility/sandboxes'; - - -

In this example you'll see how to keep a connection alive when getting contract proposals via the Deriv API. This example keeps the connection alive by sending a ping every 30 seconds.

- - - diff --git a/docs/code-examples/javascript/proposal/index.mdx b/docs/code-examples/javascript/proposal/index.mdx deleted file mode 100644 index cd3d00db9..000000000 --- a/docs/code-examples/javascript/proposal/index.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: Contract proposal status -draft: false -sidebar_label: Proposal -sidebar_position: 6 -tags: - - code - - example - - proposal -keywords: - - code - - example - - proposal -description: Learn how to feature the spot price, payout, and spot value for trading contracts with this API example. ---- - -import SandboxIframe from '@site/src/components/SandboxIframe'; -import { sandboxes } from '@site/src/components/SandboxIframe/utility/sandboxes'; - -Gets the latest price for a specific contract. - - - -This example is for getting a contract proposal. You'll be able to get the price, payout and spot value for your contract. To keep this connection alive in case of inactivity timeouts, see the example for Keep alive. diff --git a/docs/code-examples/javascript/ticks-history/index.mdx b/docs/code-examples/javascript/ticks-history/index.mdx deleted file mode 100644 index a89566ced..000000000 --- a/docs/code-examples/javascript/ticks-history/index.mdx +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: Ticks history -draft: false -sidebar_label: Ticks History -sidebar_position: 2 -tags: - - code - - example - - ticks - - history -keywords: - - code - - example - - ticks - - history -description: Subscribe to Deriv API's ticks history feature to get past tick times and prices. Integrate this feature into your trading app with this API example. ---- - -import RenderOfficialContents from '@site/src/components/RenderOfficialContents'; -import SandboxIframe from '@site/src/components/SandboxIframe'; -import { sandboxes } from '@site/src/components/SandboxIframe/utility/sandboxes'; - -With ticks history you are able to get a collection of past tick times and prices. - - - - -

We subscribe to the ticks functionality from the Deriv API websocket to keep track of current and past ticks.

- - -As an example you could create an interactive tick graph. diff --git a/docs/code-examples/javascript/ticks/index.mdx b/docs/code-examples/javascript/ticks/index.mdx deleted file mode 100644 index 78f6c518b..000000000 --- a/docs/code-examples/javascript/ticks/index.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: Tick call -draft: false -sidebar_label: Ticks -sidebar_position: 1 -tags: - - code - - example - - ticks -keywords: - - code - - example - - ticks -description: Check out an API example of a tick call connected to an API WebSocket. Start building your trading app today! ---- - -import RenderOfficialContents from '@site/src/components/RenderOfficialContents'; -import SandboxIframe from '@site/src/components/SandboxIframe'; -import { sandboxes } from '@site/src/components/SandboxIframe/utility/sandboxes'; - - -

The easiest way to understand how Deriv API works is to try our Tick call:

- - - - - -

We'll start with the ticks example because it's a pretty simple block of code to implement. You don't have to log into the Deriv account and get your app authenticated to try it.

- - - -

A tick is a measure of minimum upward or downward movement in the price of a trading commodity. We subscribe to the ticks functionality from the Deriv API websocket, which will return new tick data every second. As an example you could create an interactive tick graph with this data.

- \ No newline at end of file diff --git a/docs/code-examples/javascript/website-status/index.mdx b/docs/code-examples/javascript/website-status/index.mdx deleted file mode 100644 index 75e1ecbc0..000000000 --- a/docs/code-examples/javascript/website-status/index.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: Request Website Status -draft: false -sidebar_label: Website Status -sidebar_position: 5 -tags: - - code - - example - - website - - status -keywords: - - code - - example - - website - - status -description: Explore settings like call limits, currency information, and supported languages through a website status request. Learn with this API example. ---- - -import SandboxIframe from '@site/src/components/SandboxIframe'; -import { sandboxes } from '@site/src/components/SandboxIframe/utility/sandboxes'; - -Request the website status. From the API response you will be able to look into general settings like call limits, currencies information, supported languages and much more. - - diff --git a/docs/core-concepts/_category_.json b/docs/core-concepts/_category_.json deleted file mode 100644 index d9871fe27..000000000 --- a/docs/core-concepts/_category_.json +++ /dev/null @@ -1,9 +0,0 @@ -{ - "className": "hide-sidebar-item", - "label": "Core concepts", - "position": 2, - "link": { - "type": "generated-index", - "description": "Learn to use API WebSocket and API calls to create your customised trading app." - } -} diff --git a/docs/core-concepts/api-calls-anatomy/index.md b/docs/core-concepts/api-calls-anatomy/index.md deleted file mode 100644 index b81c275e8..000000000 --- a/docs/core-concepts/api-calls-anatomy/index.md +++ /dev/null @@ -1,198 +0,0 @@ ---- -title: Functions of API Calls -hide_title: false -draft: false -sidebar_label: Functions of API Calls -sidebar_position: 1 -tags: - - concept - - calls - - anatomy -keywords: - - trading app - - api calls - - api example -description: Set up API calls for your trading app using the API call feature. With API examples, learn to subscribe, send requests, and get response data. ---- - -## Subscribe and send - -All API calls have a send functionality for making a request and receiving a response. Certain API calls also offer a subscribe functionality allowing for updates to be sent to your application when new information becomes available. - -### Subscribe - -Several API calls provide the `subscribe` functionality. When you subscribe to an API call, you will receive a continuous stream from data of this particular API call. - -Some of these API calls automatically subscribe (e.g. [ticks](/api-explorer#ticks)) and some have an optional `subscribe` field. If you pass `1` to the `subscribe` field, the subscription will start and the server will continue to send the requested data until you unsubscribe by calling the `Forget` or `Forget all` API calls. - -For example, you can call [Tick History](/api-explorer#ticks_history) to receive tick history data. But when you add the `subscribe` option to this call, you will receive the tick history data you requested in the first response, and you will continue to receive a new response every time there is a new tick published by the server for the given symbol. - -In the message stream from `subscribe`, there is a field called `subscription`. This is the `Stream ID`. With this ID, you can identify the message stream in your logic and stop the stream with `Forget` and `Forget All` API calls. - -The data provided by API calls with the `subscribe` functionality can be used as a data source for other API calls and features. - -### Send - -If you call the API with the `send` functionality, then the server will only send back the requested data one time. In order to get updated data, you have to send the API call again. Usually, this method is used when you get other API call responses or UI events such as `Click`, `Scroll`, and more. - -### Forget - -If you want to stop the message stream created by `subscribe`, you will have to call the `Forget` API call with the correct `Stream ID`. Otherwise, you can use the `Forget All` API call to stop streams by their `Method name`. - -:::caution -For more information on the `Forget` API call, have a look at [Forget](/api-explorer#forget) and [Forget All](/api-explorer#forget_all) in the API explorer. -::: - -## Request data - -To make it easier for you to handle the request and response flow of your WebSocket connection, each Deriv WebSocket API call follows a standardised structure. You can use it for caching, validation, request, and response synchronisation. - -#### API call method name - -Every `request` in the WebSocket API includes a `method name` field that serves as a unique identifier for the request. In most cases, this `method name` will get a numerical value of `1`. However, there are some cases where the identifier property may have a string value. - -:::caution -API Call Method Name is always required. this field determines the data you'll get from our WebSocket server. -::: - -### Required fields - -Each request data has mandatory fields that you must provide, and it may also include optional fields. Let's explore this with an example from `Residence List`. - -A `Residence List` call returns a list of countries and 2-letter country codes, suitable for populating the account opening form. - -The request data for this call is as below: - -```ts showLineNumbers -{ - residence_list: 1; // Api Call Method Name - passthrough?: object; // Optional - req_id?: number; // Optional -} -``` - -The `residence_list` field is the `method name` for the call and is required. There may be other required fields related to this type of the request you want to send. To know more about `Residence List` and other API calls, please check them out in [API Explorer](/api-explorer#residence_list). - -### Optional fields - -Every call has several `Optional` fields as well. `Passthrough` and `req_id` are always part of the request data but you can choose to opt out and not use them. - -#### The `passthrough` field - -Whatever you pass to this field will be returned back to you inside a `response` object. This can be helpful when you need to simulate a stateful flow for your `requests` and `responses`. - -#### The `req_id` field - -You may need to `tag` your requests and pass them through our `WebSocket` calls. You can do so by passing a `number` to this field. It can be helpful when you need to map `requests` to `responses`. - -:::caution -To learn about additional optional fields specific to each API call, please refer to our [API Explorer](/api-explorer). -::: - -## Response data - -When you get the response for the call, there will be a `Field` with the same name as the `method name`, which contains the actual data. - -The response for the `Residence List` call: - -```js showLineNumbers -{ - echo_req: { - req_id: 1, - residence_list: 1, - }, - msg_type: 'residence_list', - req_id: 1, - residence_list: [ - { - "identity": { - "services": { - "idv": { - "documents_supported": {}, - "has_visual_sample": 0, - "is_country_supported": 0 - }, - "onfido": { - "documents_supported": { - "driving_licence": { - "display_name": "Driving Licence" - } - }, - "is_country_supported": 0 - } - } - }, - "phone_idd": "35818", - "text": "Aland Islands", - "value": "ax" - }, - { - "identity": { - "services": { - "idv": { - "documents_supported": {}, - "has_visual_sample": 0, - "is_country_supported": 0 - }, - "onfido": { - "documents_supported": { - "driving_licence": { - "display_name": "Driving Licence" - }, - "national_identity_card": { - "display_name": "National Identity Card" - }, - "passport": { - "display_name": "Passport" - } - }, - "is_country_supported": 1 - } - } - }, - "phone_idd": "355", - "text": "Albania", - "tin_format": [ - "^[A-Ta-t0-9]\\d{8}[A-Wa-w]$" - ], - "value": "al" - }, - // .... - ], -}; -``` - -Here the `residence_list` is the `method name`, and it contains the actual data you requested. To keep it short, we haven't included the rest of the array. You can check the actual response [here](/api-explorer#residence_list). - -#### The `echo_req` field - -This `Field` contains the exact `Request Data` you sent to the server. - -#### The `msg_type` field - -This `Field` helps you determine which `message` data you're getting on the message event of the WebSocket connection. For example, your `onmessage` event handler for your WebSocket connection in `JavaScript` would be: - -```js showLineNumbers -socket.onmessage = (event) => { - const receivedMessage = JSON.parse(event.data); - - switch (receivedMessage.msg_type) { - case "residence_list": - console.log("The residence list is : ",receivedMessage.residence_list) - break; - case "other_request_identifier" - console.log("the response", receivedMessage.some_other_request_identifier) - default: - console.log("receivedMessage", receivedMessage) - break; - } -} -``` - -#### The `req_id` field - -This is the `Optional` passed to the `Request Data`, you can use it for `validation`, `synchronization`, `caching`, etc. - -:::tip -The `msg_type` is always present on the response data. -::: diff --git a/docs/core-concepts/authorization-authentication/index.md b/docs/core-concepts/authorization-authentication/index.md deleted file mode 100644 index dd5886a36..000000000 --- a/docs/core-concepts/authorization-authentication/index.md +++ /dev/null @@ -1,153 +0,0 @@ ---- -title: API authentication -hide_title: false -draft: false -sidebar_label: API authentication -sidebar_position: 2 -tags: - - authentication - - authorisation -keywords: - - deriv-authentication - - deriv-authorisatio -description: Access the complete set of Deriv API features on your trading app by authenticating users with an API token. Learn to do this with an API example. ---- - -Without authorisation and authentication you'll only get access to roughly half of our API calls and features. For example, in order to buy contracts or utilise the `Copy Trading` features, your users must be authenticated and authorised by our **OAuth** provider and **WebSocket Server**. - -## Before we start - -Please make sure you have all the requirements mentioned below to continue. - -### Requirements - -1. Deriv Client account -2. Deriv API token with the appropriate access level -3. Deriv app ID - -:::note -Please refer to [Setting up a Deriv application](/docs/setting-up-a-deriv-application) for detailed instructions on how to create a Deriv API token and application. -::: - -### API token - -An API token is a unique identifier of a client that requests access from a server. It's the simplest way of authorisation. - -The access level for each API token has to match the required access level of each API call, which can be found in the [API Explorer](/api-explorer) as well. - -For example, on the screenshot below, you can see that to be able to use the Account Status, a token with read access level must be used. - -![](/img/acc_status_scope_api_explorer.png) - -Following the authorisation of a WebSocket connection, subsequent calls on that connection will be considered user actions. - -Please bear in mind that the API token can be used with any app, so both your app and your clients need to keep it secure. - -### OAuth2 - -OAuth stands for `Open Authorisation` — a protocol that allows a client to access resources hosted on a server on behalf of the user without revealing the credentials. - -This type of authorisation allows clients to log in to third-party apps using their Deriv accounts without creating an API token. In this case, the third-party app does not see the user's password or permanent API token, which makes it safer. - -The OAuth2 authentication requires more steps to set up, but it is the safest way for developers to share access to their app with their clients. - -For more information on OAuth2, visit [this guide](https://aaronparecki.com/oauth-2-simplified/). - -Here is the visual representation of how the OAuth authorisation connection works: - -![OAuth flow](/img/how_oauth_works.png 'OAuth flow') - -## The authentication process - -In order to authenticate your user, specify the URL that will be used as the OAuth Redirect URL on the [Dashboard](/dashboard) page, **Register application** tab in the **OAuth details** fields. Then, add a login button on your website or app and direct users to **`https://oauth.deriv.com/oauth2/authorize?app_id=your_app_id`** where your_app_id is the ID of your app. - -![Deriv OAuth Login](/img/oauth_login.png 'Deriv OAuth Login') - -Once a user signs up/logs in, they will be redirected to the URL that you entered as the Redirect URL. This URL will have arguments added to it with the user's session tokens, and will look similar to this: - -`https://[YOUR_WEBSITE_URL]/redirect/?acct1=cr799393& token1=a1-f7pnteezo4jzhpxclctizt27hyeot&cur1=usd& acct2=vrtc1859315& token2=a1clwe3vfuuus5kraceykdsoqm4snfq& cur2=usd` - -## The authorisation process - -The query parameters in the Redirect URL are the user's accounts and their related session tokens. You can map the query parameters to an array using the following approach: - -```js showLineNumbers -const user_accounts = [ - { - account: 'cr799393', - token: 'a1-f7pnteezo4jzhpxclctizt27hyeot', - currency: 'usd', - }, - { - account: 'vrtc1859315', - token: 'a1clwe3vfuuus5kraceykdsoqm4snfq', - currency: 'usd', - }, -]; -``` - -To authorise the user based on the user's **selected** account, call the [authorize](/api-explorer#authorize) API call with the user's **selected** account **session token**: - -```js showLineNumbers -{ - "authorize": "a1-f7pnteezo4jzhpxclctizt27hyeot" -} -``` - -The response for the `authorize` call would be an object as below: - -```js showLineNumbers -{ - "account_list": [ - { - "account_type": "trading", - "created_at": 1647509550, - "currency": "USD", - "is_disabled": 0, - "is_virtual": 0, - "landing_company_name": "svg", - "loginid": "CR799393", - "trading": {} - }, - { - "account_type": "trading", - "created_at": 1664132232, - "currency": "ETH", - "is_disabled": 0, - "is_virtual": 0, - "landing_company_name": "svg", - "loginid": "VRTC1859315", - "trading": {} - }, - ], - "balance": 0, - "country": "id", - "currency": "USD", - "email": "user_mail@email_provider.com", - "fullname": " John Doe", - "is_virtual": 0, - "landing_company_fullname": "Deriv (SVG) LLC", - "landing_company_name": "svg", - "local_currencies": { - "IDR": { - "fractional_digits": 2 - } - }, - "loginid": "CR799393", - "preferred_language": "EN", - "scopes": [ - "read", - "trade", - "trading_information", - "payments", - "admin" - ], - "trading": {}, - "upgradeable_landing_companies": [ - "svg" - ], - "user_id": 12345678 - } -``` - -Now, the user is authorised, and you can use Deriv API calls on behalf of the account. diff --git a/docs/core-concepts/copytrading/index.md b/docs/core-concepts/copytrading/index.md deleted file mode 100644 index 47288386e..000000000 --- a/docs/core-concepts/copytrading/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: Copy trading facilities -hide_title: false -draft: false -sidebar_label: Copy trading -sidebar_position: 4 -tags: - - copy trading - - trading -keywords: - - trading - - concept - - calls - - anatomy -description: Copy Trading ---- - -## What is it? - -Copy Trading is becoming popular in the financial markets; it allows a client (the Copier) to automatically copy the trades of another client (the Trader). - -## Becoming a Trader - -To become a Trader (i.e. to allow others to follow your trades), set the “allow_copiers” setting via the [set settings](/api-explorer#set_settings) call. - -The Trader then creates a read-only API token and provides it to the Copier. - -Enabling the allow_copiers setting will also make the [copytrading statistics](/api-explorer#copytrading_statistics) call work. The statistics API call provides the information about an account (this is so that potential copiers have an idea about the trader’s past performance). - -## Becoming a Copier - -To become a copier, use the [copy start](/api-explorer#copy_start) call. To stop copying, use the [copy stop](/api-explorer#copy_stop) call. diff --git a/docs/core-concepts/websocket/index.md b/docs/core-concepts/websocket/index.md deleted file mode 100644 index 7be3aca7f..000000000 --- a/docs/core-concepts/websocket/index.md +++ /dev/null @@ -1,148 +0,0 @@ ---- -title: WebSocket -hide_title: false -draft: false -sidebar_label: WebSocket -sidebar_position: 0 -tags: - - concept - - websocket -keywords: - - trading app - - websocket protocol - - websocket connections -description: Learn about WebSocket protocol and WebSocket connections, and how to integrate them so you can enable data exchanges on your trading app. ---- - -## What are WebSockets? - -The `WebSocket` protocol, described in the specification [RFC 6455](https://datatracker.ietf.org/doc/html/rfc6455), provides a way to exchange data between the browser and the server via a persistent connection. The data can be passed in both directions as “packets” without breaking the connection or needing additional HTTP requests. - -WebSocket is especially great for services that require continuous data exchange, e.g. real-time trading systems and so on. - -## A simple example - -To open a WebSocket connection, we need to create `new WebSocket` using the special protocol `ws`or `wss` in the url. Here is how you can do that in `JavaScript`: - -```js -let socket = new WebSocket('wss://ws.derivws.com/websockets/v3?app_id=1089'); -``` - -:::caution -Using `wss://` is always the better choice. The `wss://` protocol is not only encrypted, but also more reliable. - -On the other hand, the `ws://` data is not encrypted and can be visible to intermediaries. Old proxy servers may encounter "strange" headers and terminate the connection. - -`wss://` stands for WebSocket over TLS, similar to how HTTPS is HTTP over TLS. With the transport security layer, data is encrypted by the sender and decrypted by the receiver. This means that encrypted data packets can successfully pass through proxies without being inspected. -::: - -Once the socket is created, we should listen to events on it. There are 4 events altogether: - -- Open – Connection established -- Message – Data received -- Error – WebSocket error -- Close – Connection closed - -Sending a message can be done via socket.send(data). - -Here’s an example in `JavaScript`: - -```js showLineNumbers -const app_id = 1089; // Replace with your app_id or leave as 1089 for testing. -const socket = new WebSocket(`wss://ws.derivws.com/websockets/v3?app_id=${app_id}`); - -socket.onopen = function (e) { - console.log('[open] Connection established'); - console.log('Sending to server'); - const sendMessage = JSON.stringify({ ping: 1 }); - socket.send(sendMessage); -}; - -socket.onmessage = function (event) { - console.log(`[message] Data received from server: ${event.data}`); -}; - -socket.onclose = function (event) { - if (event.wasClean) { - consloe.log(`[close] Connection closed cleanly, code=${event.code} reason=${event.reason}`); - } else { - // e.g. server process killed or network down - // event.code is usually 1006 in this case - console.log('[close] Connection died'); - } -}; - -socket.onerror = function (error) { - console.log(`[error]`); -}; -``` - -## Why do we need WebSockets and when should we avoid them? - -WebSockets are an essential client-server communication tool. To benefit the most from their potential, it's important to understand how they can be helpful and when it's best to avoid using them. It’s explained extensively in the next section. - -Use WebSockets in the following cases: - -1. ‍When you're developing a real-time web application. - The most customary use of WebSocket is in real-time application development wherein it assists in a continual display of data at the client end. As the back-end server sends back this data continuously, a WebSocket allows uninterrupted pushing or transmitting of this data in the already open connection. The use of WebSockets makes such data transmission quick and leverages the application's performance. -2. For trading websites, such as Deriv. - Here, WebSocket assists in data handling that is impelled by the deployed back-end server to the client. -3. ‍When creating a chat application. - Chat application developers call out WebSockets for help in operations like a one-time exchange and publishing/broadcasting messages. As the same WebSocket connection is used for sending/receiving messages, communication becomes easy and quick. - -Now that we've established where WebSockets should be used, let's see where it is best to avoid them. This will help you steer clear of unnecessary operational hassles. - -WebSockets shouldn't be taken onboard when all that is needed is fetching old data or data that's to be processed only once. In these cases, using HTTP protocols is a wise choice. - -## WebSocket vs HTTP - -As both HTTP and WebSocket protocols are employed for application communication, people often get confused and find it difficult to pick one. - -As told previously, WebSocket is a framed and bidirectional protocol. On the other hand, HTTP is a unidirectional protocol functioning above the TCP protocol. - -As the WebSocket protocol is capable of supporting continual data transmission, it’s majorly used in real-time application development. HTTP is stateless and is used for the development of [RESTful](https://de.wikipedia.org/wiki/Representational_State_Transfer) and [SOAP](https://de.wikipedia.org/wiki/SOAP) applications. SOAP can still use HTTP for implementation, but REST is widely spread and used. - -In WebSocket, communication occurs at both ends, which makes it a faster protocol. In HTTP, the connection is built at one end, making it a bit more sluggish than WebSocket. - -WebSocket uses a unified TCP connection and needs one party to terminate the connection. Until it happens, the connection remains active. HTTP needs to build a distinct connection for separate requests. Once the request is completed, the connection breaks automatically. - -## How are WebSocket connections established? - -The process starts with a WebSocket handshake that involves using a new scheme (ws or wss). To help you understand, consider them equivalent to HTTP and secure HTTP (HTTPS) respectively. - -Using this scheme, servers and clients are expected to follow the standard WebSocket connection protocol. The WebSocket connection establishment begins with a HTTP request upgrading that features a couple of headers such as Connection: Upgrade, Upgrade: WebSocket, Sec-WebSocket- Key, and so on. - -Here is how this connection is established: - -1. **The Request :** The Connection Upgrade header denotes the WebSocket handshake while the Sec-WebSocket-Key features Base64-encoded random value. This value is arbitrarily generated during every WebSocket handshake. Besides the above, the key header is also a part of this request. - -The above-listed headers, when combined, form an HTTP GET request. It will have similar data in it: - -``` -GET ws://websocketexample.com:8181/ HTTP/1.1 -Host: localhost:8181 -Connection: Upgrade -Pragma: no-cache -Cache-Control: no-cache -Upgrade: websocket -Sec-WebSocket-Version: 13 -Sec-WebSocket-Key: b6gjhT32u488lpuRwKaOWs== -``` - -To clarify Sec-WebSocket-Version, one can explain the WebSocket protocol version ready to use for the client. - -2. **The Response:** The response header, Sec-WebSocket-Accept, features the rest of value submitted in the Sec-WebSocket-Key request header. This is connected with a particular protocol specification and is used widely to keep misleading information at bay. In other words, it enhances the API security and stops ill-configured servers from creating blunders in the application development. - -On the success of the previously-sent request, a response similar to the below-mentioned text sequence will be received: - -``` -HTTP/1.1 101 Switching Protocols -Upgrade: websocket -Connection: Upgrade -Sec-WebSocket-Accept: rG8wsswmHTJ85lJgAE3M5RTmcCE= -``` - -## References - -- **[WebSockets APIs - MDN](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket)** -- **[WebSocket - Javascript Info](https://javascript.info/websocket)** diff --git a/docs/frameworks/_category_.json b/docs/frameworks/_category_.json deleted file mode 100644 index f4e0d2021..000000000 --- a/docs/frameworks/_category_.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "label": "Frameworks", - "position": 6, - "link": { - "type": "generated-index" - } -} diff --git a/docs/frameworks/angular/_category_.json b/docs/frameworks/angular/_category_.json deleted file mode 100644 index 5f8eeda41..000000000 --- a/docs/frameworks/angular/_category_.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "label": "Angular", - "position": 2, - "link": { - "type": "generated-index", - "description": "5 minutes to learn the most important Docusaurus concepts." - } -} diff --git a/docs/frameworks/react/_category_.json b/docs/frameworks/react/_category_.json deleted file mode 100644 index 9b78e75d4..000000000 --- a/docs/frameworks/react/_category_.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "label": "React", - "position": 1, - "link": { - "type": "generated-index", - "description": "5 minutes to learn the most important Docusaurus concepts." - } -} diff --git a/docs/frameworks/solidjs/_category_.json b/docs/frameworks/solidjs/_category_.json deleted file mode 100644 index 347f8b50d..000000000 --- a/docs/frameworks/solidjs/_category_.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "label": "SolidJS", - "position": 3, - "link": { - "type": "generated-index", - "description": "5 minutes to learn the most important Docusaurus concepts." - } -} diff --git a/docs/frameworks/svelte/_category_.json b/docs/frameworks/svelte/_category_.json deleted file mode 100644 index a6e1db07b..000000000 --- a/docs/frameworks/svelte/_category_.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "label": "Svelte", - "position": 4, - "link": { - "type": "generated-index", - "description": "5 minutes to learn the most important Docusaurus concepts." - } -} diff --git a/docs/frameworks/vue/_category_.json b/docs/frameworks/vue/_category_.json deleted file mode 100644 index b165038ea..000000000 --- a/docs/frameworks/vue/_category_.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "label": "Vue", - "position": 5, - "link": { - "type": "generated-index", - "description": "5 minutes to learn the most important Docusaurus concepts." - } -} diff --git a/docs/guides/_category_.json b/docs/guides/_category_.json deleted file mode 100644 index d06a9c83b..000000000 --- a/docs/guides/_category_.json +++ /dev/null @@ -1,9 +0,0 @@ -{ - "className": "hide-sidebar-item", - "label": "Guides", - "position": 6, - "link": { - "type": "generated-index", - "description": "A guide to the Deriv API, including API examples to create a trading app with comprehensive features similar to Deriv Trader. Get started today!" - } -} diff --git a/docs/guides/_markup-calculation/index.md b/docs/guides/_markup-calculation/index.md deleted file mode 100644 index 9c3206efd..000000000 --- a/docs/guides/_markup-calculation/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: Charge contract markups -hide_title: true -draft: false -sidebar_label: Markup calculation -sidebar_position: 2 -tags: - - concept - - earn - - earning - - commission - - markup -keywords: - - concept - - earn - - earning - - commission - - markup -description: Learn how to charge markups on trading contracts purchased through your trading app. ---- - -## Markup - -Increase your earnings by charging markups on each contract purchased through the trading app you've created with the Deriv API. The markup is defined by you and can be up to 3%. - -Below is an example of how the markup is calculated. - -To get a payout of **2.00 USD**: - -- Client stake without markup = **1.07 USD** - -With the markup (e.g. 2%), a client pays: - -- Client's stake with the markup = Stake + (payout x markup) -- Client's stake with the markup = 1.07 USD + (2 USD x 2%) = **1.11 USD** - -## Earning commission - -Earn commissions on trades and payments made by your clients through the websites and apps you create with the Deriv API. Get more details about the commission plans [here](https://www.deriv.com/partners/affiliate-ib). diff --git a/docs/guides/about-the-deriv-api/index.md b/docs/guides/about-the-deriv-api/index.md deleted file mode 100644 index 322403b69..000000000 --- a/docs/guides/about-the-deriv-api/index.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: About Deriv API -hide_title: true -draft: false -sidebar_label: About the Deriv API -sidebar_position: 0 -tags: - - concept - - api - - tutorial - - guide - - create - - application - - authorise - - register - - integration -keywords: - - concept - - api - - tutorial - - guide - - create - - application - - authorise - - register - - integration -description: Learn about Deriv API, its features, and API documentation with code examples, and how to use it to build your trading app. ---- - -## What is the Deriv API? - -The Deriv API is a tool that allows developers to build custom trading applications that interact with the Deriv trading platform. Think of it as a way for developers to create their own specialized tools to help people trade on the Deriv platform in a more efficient or personalized way. With the Deriv API, developers can access a wide range of functionality, including placing trades, retrieving account data, managing orders, and accessing real-time market data. This can be helpful for traders who want to customize their trading experience or use specialized tools to make more informed trading decisions. Overall, the Deriv API gives you more flexibility and control over your trading experience, allowing you to create your own customized solutions that better fit your trading style and goals. - -## How do I use it? - -Here are the steps to use the Deriv API: - -1. **Register for a Deriv API account**: Go to the Deriv API website and sign up for an account. Once you have registered, you will receive an API token that you can use to authenticate your API requests. - -2. **Familiarise yourself with the API documentation**: The Deriv API provides comprehensive documentation that explains how to use the API endpoints, including the available parameters and response formats. Make sure you are familiar with the documentation before you start using the API. - -3. **Create an API application**: To create an API application, you need to provide a name for your application and a Redirect URL. The Redirect URL is the URL that the user will be redirected to after they have authorised your application to access their Deriv account. - -4. **Authorise your application**: Once you have created your API application, you need to authorise it to access your Deriv account. This involves logging into your Deriv account and granting permission for your application to access your account data. - -5. **Make API requests**: Once your application is authorised, you can start making API requests. You can use the API to retrieve information about your account, place trades, manage orders, and perform other trading-related tasks. - -6. **Test your API integration**: Before launching your application, make sure you thoroughly test your API integration to ensure that it is working correctly. diff --git a/docs/guides/monetizing-the-deriv-api/index.md b/docs/guides/monetizing-the-deriv-api/index.md deleted file mode 100644 index fdd0150f8..000000000 --- a/docs/guides/monetizing-the-deriv-api/index.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -title: Monetise your trading app -hide_title: true -draft: false -sidebar_label: Monetizing the Deriv API -sidebar_position: 1 -sidebar_class_name: hide-sidebar-item -tags: - - concept - - earn - - earning - - monetize - - monetization - - api - - websocket -keywords: - - concept - - earn - - earning - - monetize - - monetization - - api - - websocket -description: Find out how to monetise the Deriv API by becoming a Deriv affiliate, advertising on your trading app, or offering premium features. ---- - -## Monetizing the Deriv API - -There are several ways to monetize the Deriv API: - -1. **Charging for access to your trading application**: If your Deriv API-based custom trading application offers value to users, you can charge them a subscription or a one-time fee for accessing it, making it a feasible revenue stream for your business. - -2. **Charging for premium features**: If your trading application has advanced features, such as real-time market data, advanced charting tools, and other premium features that offer added value to users, you can generate additional revenue by charging users for access to those features. - -3. **Affiliate marketing**: You can join Deriv's affiliate programme and earn commissions for referring new users to the Deriv platform. This can be a good option if you have an audience that is interested in trading or investing. - -4. **Referral fees**: If you have built a trading application that integrates with the Deriv platform, you can offer referral fees to existing users who refer new users to your application. This incentive can encourage them to spread the word about your application, helping you to grow your user base. - -5. **Advertising**: If you have built a trading application that has a large user base, you could consider selling advertising space to relevant advertisers. This can be a good way to generate additional revenue. - -6. **Markup**: Use the Deriv API to create your own websites and apps, and earn commissions on the trades and payments your clients make, monetizing your creations through markup. - -## Markup - -Boost your revenue by applying markups on every contract purchased through the trading app you've developed using the Deriv API. You can set the markup yourself, up to a maximum of 3%. - -We support all trade types, including both vanilla and turbo options. - -Here's an example of how the markup is calculated: - -For Digital Options (Existing): - -- Stake: **USD 25.50** -- Payout: **USD 50** -- Markup: **2%** of **USD 50** (Payout) = **USD 1** -- Client Balance Debited: **USD 26.50** -- Trade Details: Show **USD 26.50** -- Contract value calculation: Based on **USD 25.50** -- Profit Calculation: Based on **USD 26.50** stake - -For Multipliers, Accumulators, Turbos and Vanilla options (Newly added): - -- Markup: **2%** of **USD 50** (Stake) = **USD 1** -- Client Balance Debited: **USD 50** -- Trade Details: Show **USD 50** -- Contract value calculation: Based on **USD 49** -- Profit Calculation: Based on **USD 50** stake - -## Earning commission - -Earn commissions on trades and payments made by your clients through the websites and apps you create with the Deriv API. Get more details about the commission plans [here](https://www.deriv.com/partners/affiliate-ib). diff --git a/docs/guides/oauth2/index.md b/docs/guides/oauth2/index.md deleted file mode 100644 index 57b19a9b0..000000000 --- a/docs/guides/oauth2/index.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: Open authorisation -hide_title: true -draft: false -sidebar_label: OAuth2 -sidebar_position: 4 -tags: - - concept - - earn - - earning - - commission - - markup -keywords: - - concept - - earn - - earning - - commission - - markup -description: Learn about OAuth authorisation, logging in without an API token, and how you can use it to improve the user experience of your trading app. ---- - -## What is OAuth2? - -OAuth stands for Open Authorisation — a protocol that enables a client to access a user's resources on a server without revealing the user's login credentials. - -This type of authorisation allows clients to log in to third-party apps using their Deriv accounts without creating an API token. In this case, the third-party app does not see the user's password or permanent API token, which makes it safer. - -The OAuth2 authentication requires more setup steps, but it is the most secure way for developers to grant access to their app for clients. - -For more information on OAuth2, [see this guide](https://aaronparecki.com/oauth-2-simplified/). - -### How to use OAuth authorisation - -1. Specify the URL that will be used as the **OAuth Redirect URL** on the app registration page in the **Website URL field**. - -2. Add a login button on your website or app and direct users to `https://oauth.deriv.com/oauth2/authorize?app_id=your_app_id` where your_app_id is the ID of your app. - -3. Once a user signs up, they will be redirected to the URL that you entered as the **Redirect URL**. This URL will have arguments added to it with the user's session tokens, and will look similar to: `https://[YOUR_WEBSITE_URL]/redirect/?acct1=cr799393& token1=a1-f7pnteezo4jzhpxclctizt27hyeot&cur1=usd& acct2=vrtc1859315& token2=a1clwe3vfuuus5kraceykdsoqm4snfq& cur2=usd&state=` - -4. In the parameters of the URL, you will see all the accounts and the session token for each account. Pass these tokens to the Authorize API call in order to perform actions on behalf of the account. diff --git a/docs/intro.md b/docs/intro.md deleted file mode 100644 index d33238758..000000000 --- a/docs/intro.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -title: Quick start -hide_title: false -draft: false -sidebar_label: Quick start -sidebar_position: 0 -sidebar_class_name: hide-sidebar-item -tags: - - Quick start - - getting started - - quick startup -keywords: - - deriv - - api - - getting started - - quick startup -description: Get an overview of the available Deriv API code examples and languages, and how to use it to create your trading app. ---- - -```mdx-code-block -import Link from '@docusaurus/Link'; -import RenderOfficialContents from '@site/src/components/RenderOfficialContents'; -``` - -Our Documentation is divided in several sections: - - -
    -
  • - Core concepts -
    • -
  • - Code examples -
    • -
  • - Languages -
    • -
  • - Guides -
    • -
  • - Setting up a deriv app -
    • -
-
    -
  • - Code examples -
    • -
- - - -

Core Concepts

- - - - Have a look at the Core concepts pages and take your - time to read through it. These concepts will help you get familiar with our WebSocket server api - and how to use it more efficiently. They are not related to any of our frameworks or libraries. - - - - When you read through the Core concepts page, you can - start choosing your implementation approach based on the language, framework or library you want - to use in your application. - - -

Code Examples

- -If you want to know how you can implement our API within your code, then we suggest to have a look -at our Code examples. These code examples come in -`CodeSandboxes`. This allows you to easily fork the code examples and experiment with them for -personal use. For now we only have JavaScript code examples, but, we plan to add more examples -that are created with different languages, frameworks and libraries in the near future. - - -

Languages

- - - - When using our code examples, we also suggest to have a look at our{' '} - Languages section. Here, we describe in detail how you - can setup your personal project properly to make use of our API. This will surely come helpful - when you try to integrate some of our code examples in your own project. - - - -

Guides

- - - - If you want to know for example how you can `monetize your application` or how to create a - `secure way for users to log in` to your application, then we provide a handful of{' '} - Guides that can assist you with that. - - - -

Setting up a Deriv application

- - - - If you want to know more about the essentials that are needed to setup your own application, - then have a look at the{' '} - Setting up a Deriv application section. - diff --git a/docs/languages/_category_.json b/docs/languages/_category_.json deleted file mode 100644 index 7a430e1c4..000000000 --- a/docs/languages/_category_.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "className": "hide-sidebar-item", - "label": "Languages", - "position": 4, - "link": { - "type": "generated-index", - "title": "Programming languages", - "description": "Select your preferred programming language to create a trading app with the help of our WebSocket API. Start learning with these code examples." - } -} diff --git a/docs/languages/dart/_category_.json b/docs/languages/dart/_category_.json deleted file mode 100644 index 9eeba281a..000000000 --- a/docs/languages/dart/_category_.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "label": "Dart", - "position": 2, - "link": { - "type": "generated-index" - } -} diff --git a/docs/languages/intro.md b/docs/languages/intro.md deleted file mode 100644 index f8475a562..000000000 --- a/docs/languages/intro.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Introduction -sidebar_label: Introduction -sidebar_position: 0 -description: Get step-by-step instructions on how to use pure languages on Deriv's WebSocket API. Start building your trading app with this API example. ---- - -Each language section contains step-by-step instructions on how to use the `Deriv WebSocket Server APIs` with pure language features. So if it's the first time you're using our docs please go through each section in order to get the most out of them. - -:::tip -You can jump right in to any section. There are links to requirements to help get started in each step. -::: diff --git a/docs/languages/javascript/_category_.json b/docs/languages/javascript/_category_.json deleted file mode 100644 index af90334f3..000000000 --- a/docs/languages/javascript/_category_.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "label": "JavaScript", - "position": 1, - "link": { - "type": "generated-index", - "description": "Start building your trading app with Javascript, HTML, and CSS via our WebSocket API." - } -} diff --git a/docs/languages/javascript/get-country-list/index.md b/docs/languages/javascript/get-country-list/index.md deleted file mode 100644 index 2f90619dd..000000000 --- a/docs/languages/javascript/get-country-list/index.md +++ /dev/null @@ -1,193 +0,0 @@ ---- -title: Get country list -sidebar_label: Get a list of countries -sidebar_position: 2 -tags: - - country_list - - javascript -keywords: - - country_list - - javascript -description: Get information about your users by adding a list of countries to your trading app. Learn how to do that with this JavaScript API example. ---- - - - -To get a list of countries, update the open event listener using the following approach: - -```js title="index.js" showLineNumbers -const ping_interval = 12000; // it's in milliseconds, which equals to 120 seconds -let interval; -// subscribe to `open` event -websocket.addEventListener('open', (event) => { - console.log('websocket connection established: ', event); - const payload = JSON.stringify({ - residence_list: 1, - }); - websocket.send(payload); - - // to Keep the connection alive - interval = setInterval(() => { - const sendMessage = JSON.stringify({ ping: 1 }); - websocket.send(sendMessage); - }, ping_interval); -}); -``` - -Now, update the `message` event listener to render the data: - -```js title="index.js" showLineNumbers -// subscribe to `message` event -websocket.addEventListener('message', (event) => { - const receivedMessage = JSON.parse(event.data); - switch (receivedMessage.msg_type) { - case 'residence_list': - console.log('list of countries', receivedMessage.residence_list); - break; - case 'ping': - console.log('ping/pong response: ', receivedMessage.ping); - break; - default: - console.log('received message: ', receivedMessage); - break; - } -}); -``` - -The response should be an object: - -```json showLineNumbers -{ - "echo_req": { - "req_id": 1, - "residence_list": 1 - }, - "msg_type": "residence_list", - "req_id": 1, - "residence_list": [ - { - "identity": { - "services": { - "idv": { - "documents_supported": {}, - "has_visual_sample": 0, - "is_country_supported": 0 - }, - "onfido": { - "documents_supported": {}, - "is_country_supported": 0 - } - } - }, - "phone_idd": "35818", - "text": "Aland Islands", - "value": "ax" - }, - { - "identity": { - "services": { - "idv": { - "documents_supported": {}, - "has_visual_sample": 0, - "is_country_supported": 0 - }, - "onfido": { - "documents_supported": { - "driving_licence": { - "display_name": "Driving Licence" - }, - "national_identity_card": { - "display_name": "National Identity Card" - }, - "passport": { - "display_name": "Passport" - } - }, - "is_country_supported": 1 - } - } - }, - "phone_idd": "355", - "text": "Albania", - "tin_format": ["^[A-Ta-t0-9]\\d{8}[A-Wa-w]$"], - "value": "al" - } - ] -} -``` - -With this call, you will get useful information about supported countries, such as: - -- A `2-letter` code for each country -- `Identity` service providers for each country -- Country Tax Identifier Format (`tin_format`) -- etc. - -This can be useful for account creation forms, in which you need to ask users to provide validated information about their identity base, depending on their country of residence. - -:::caution -For address and tax ID validations, please use the provided 'tin_format' for the country. -::: - -User's country is important for your next steps. It determines which assets and features they can use. - -:::tip -It's better to get the list of countries before populating your form. -::: - -:::danger -You will need detailed content about `IDV` and `ONFIDO` identity services, their differences and possibilities. -::: - -Your final code will be: - -```js title="index.js" showLineNumbers -const app_id = 1089; // Replace with your app_id or leave as 1089 for testing. -const websocket = new WebSocket(`wss://ws.derivws.com/websockets/v3?app_id=${app_id}`); -const ping_interval = 12000; // it's in milliseconds, which equals to 120 seconds -let interval; - -// subscribe to `open` event -websocket.addEventListener('open', (event) => { - console.log('websocket connection established: ', event); - const payload = JSON.stringify({ - residence_list: 1, - }); - websocket.send(payload); - - // to Keep the connection alive - interval = setInterval(() => { - const sendMessage = JSON.stringify({ ping: 1 }); - websocket.send(sendMessage); - }, ping_interval); -}); - -// subscribe to `message` event -websocket.addEventListener('message', (event) => { - const receivedMessage = JSON.parse(event.data); - switch (receivedMessage.msg_type) { - case 'residence_list': - console.log('list of countries', receivedMessage.residence_list); - break; - case 'ping': - console.log('ping/pong response: ', receivedMessage.ping); - break; - default: - console.log('received message: ', receivedMessage); - break; - } -}); - -// subscribe to `close` event -websocket.addEventListener('close', (event) => { - console.log('websocket connectioned closed: ', event); - clearInterval(interval); -}); - -// subscribe to `error` event -websocket.addEventListener('error', (event) => { - console.log('an error happend in our websocket connection', event); -}); -``` diff --git a/docs/languages/javascript/project-setup/index.md b/docs/languages/javascript/project-setup/index.md deleted file mode 100644 index c1bf8ab96..000000000 --- a/docs/languages/javascript/project-setup/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: Project setup | JavaScript -sidebar_label: Project setup -sidebar_position: 0 -tags: - - javascript -keywords: - - js - - project-setup -description: Create a directory for your next API trading app project using a WebSocket. ---- - -### Create a project - -We are going to create a simple `HTML` page that contains our JavaScript file, which will handle our WebSocket connection. First, create a directory for your next project: - -```bash -mkdir deriv-websocket-demo -``` - -Navigate to the `deriv-websocket-demo` folder: - -```bash -cd deriv-websocket-demo -``` - -Next, create the required files as you see below: - -```bash -touch index.html index.css index.js -``` - -:::tip -We suggest using [Visual Studio Code](https://code.visualstudio.com/) with [Live Server Extension](https://marketplace.visualstudio.com/items?itemName=ritwickdey.LiveServer) enabled. This will help you a lot with implementations. -::: - -Now, open the `index.html` file or use the [Live Server Extension](https://marketplace.visualstudio.com/items?itemName=ritwickdey.LiveServer). - -Now, change the content of the files using the following approach: - -```js title="index.js" showLineNumbers -console.log('we will create our websocket connection here'); -``` - -```html title="index.html" showLineNumbers - - - - - - - Deriv HTML JS Demo - - -

Deriv WebSocket API demo

- - diff --git a/examples/active_symbols/index.js b/examples/active_symbols/index.js deleted file mode 100644 index 38d91a59c..000000000 --- a/examples/active_symbols/index.js +++ /dev/null @@ -1,37 +0,0 @@ -import DerivAPIBasic from 'https://cdn.skypack.dev/@deriv/deriv-api/dist/DerivAPIBasic'; - -const app_id = 1089; // Replace with your app_id or leave the current one for testing. -const connection = new WebSocket(`wss://ws.derivws.com/websockets/v3?app_id=${app_id}`); -const api = new DerivAPIBasic({ connection }); - -// Currently gets all available symbols. -const active_symbols_request = { - // landing_company: "maltainvest", // Uncomment landing_company if you want to retrieve specific symbols. - active_symbols: 'brief', - product_type: 'basic', -}; - -const activeSymbolsResponse = async (res) => { - const data = JSON.parse(res.data); - - if (data.error !== undefined) { - console.log('Error : ', data.error?.message); - connection.removeEventListener('message', activeSymbolsResponse, false); - await api.disconnect(); - } - - if (data.msg_type === 'active_symbols') { - const sanitizedDataString = JSON.stringify(data.active_symbols); - console.log(JSON.parse(sanitizedDataString)); - } - - connection.removeEventListener('message', activeSymbolsResponse, false); -}; - -const getActiveSymbols = async () => { - connection.addEventListener('message', activeSymbolsResponse); - await api.activeSymbols(active_symbols_request); -}; - -const active_symbols_button = document.querySelector('#activeSymbols'); -active_symbols_button.addEventListener('click', getActiveSymbols); diff --git a/examples/active_symbols/package.json b/examples/active_symbols/package.json deleted file mode 100644 index 229967170..000000000 --- a/examples/active_symbols/package.json +++ /dev/null @@ -1,28 +0,0 @@ -{ - "name": "static", - "version": "1.0.0", - "description": "This is a static template with no bundling", - "main": "index.html", - "scripts": { - "start": "serve", - "build": "echo This is a static template, there is no bundler or bundling involved!" - }, - "repository": { - "type": "git", - "url": "git+https://github.com/codesandbox-app/static-template.git" - }, - "keywords": [ - "static", - "template", - "codesandbox" - ], - "author": "Ives van Hoorne", - "license": "MIT", - "bugs": { - "url": "https://github.com/codesandbox-app/static-template/issues" - }, - "homepage": "https://github.com/codesandbox-app/static-template#readme", - "devDependencies": { - "serve": "^11.2.0" - } -} diff --git a/examples/active_symbols/sandbox.config.json b/examples/active_symbols/sandbox.config.json deleted file mode 100644 index 5866ed744..000000000 --- a/examples/active_symbols/sandbox.config.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "template": "static" -} diff --git a/examples/auth/index.html b/examples/auth/index.html deleted file mode 100644 index a829ed9de..000000000 --- a/examples/auth/index.html +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - - - Static Template - - - -