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

Commit

Permalink
Merge pull request #252 from mariovw-deriv/binary-com/deriv-api-docs
Browse files Browse the repository at this point in the history 
JSON Schema Update
  • Loading branch information
@ali-hosseini-deriv
ali-hosseini-deriv authored Oct 11, 2023
2 parents fc346b7 + 060adae commit 3a6ff98
Show file tree
Hide file tree
Showing 348 changed files with 26,510 additions and 20,625 deletions.
233 changes: 233 additions & 0 deletions _data/v3.yml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,233 @@
groups:
- label: All Calls
methods:
- name: active_symbols
title: Active Symbols
- name: api_token
title: API Token
- name: app_delete
title: 'Application: Delete'
- name: app_get
title: 'Application: Get Details'
- name: app_list
title: 'Application: List'
- name: app_markup_details
title: 'Application: Markup Details'
- name: app_markup_statistics
title: 'Application: Markup Statistics'
- name: app_register
title: 'Application: Register'
- name: app_update
title: 'Application: Update'
- name: asset_index
title: Asset Index
- name: authorize
title: Authorize
- name: balance
title: Balance
- name: buy
title: Buy Contract
- name: buy_contract_for_multiple_accounts
title: Buy Contract for Multiple Accounts
- name: cancel
title: Cancel a Contract
- name: cashier
title: Cashier Information
- name: contract_update
title: Update Contract
- name: contract_update_history
title: Update Contract History
- name: contracts_for
title: Contracts For Symbol
- name: copy_start
title: 'Copy Trading: Start'
- name: copy_stop
title: 'Copy Trading: Stop'
- name: copytrading_list
title: 'Copy Trading: List'
- name: copytrading_statistics
title: 'Copy Trading: Statistics'
- name: crypto_config
title: Cryptocurrency configurations
- name: document_upload
title: Document Upload
- name: economic_calendar
title: Economic Calendar
- name: exchange_rates
title: Exchange Rates
- name: forget
title: Forget
- name: forget_all
title: Forget All
- name: get_account_status
title: Account Status
- name: get_financial_assessment
title: Get Financial Assessment
- name: get_limits
title: Account Limits
- name: get_self_exclusion
title: Get Self-Exclusion
- name: get_settings
title: Get Account Settings
- name: identity_verification_document_add
title: Identity Verification Add Document
- name: kyc_auth_status
title: KYC Authentication Status
- name: landing_company
title: Landing Company
- name: landing_company_details
title: Landing Company Details
- name: login_history
title: Login History
- name: logout
title: Log Out
- name: mt5_deposit
title: 'MT5: Deposit'
- name: mt5_get_settings
title: 'MT5: Get Setting'
- name: mt5_login_list
title: 'MT5: Accounts List'
- name: mt5_new_account
title: 'MT5: New Account'
- name: mt5_password_change
title: 'MT5: Password Change'
- name: mt5_password_check
title: 'MT5: Password Check'
- name: mt5_password_reset
title: 'MT5: Password Reset'
- name: mt5_withdrawal
title: 'MT5: Withdrawal'
- name: new_account_maltainvest
title: 'New Real-Money Account: Deriv Investment (Europe) Ltd'
- name: new_account_real
title: 'New Real-Money Account: Default Landing Company'
- name: new_account_virtual
title: New Virtual-Money Account
- name: oauth_apps
title: OAuth Applications
- name: p2p_advert_create
title: P2P Advert Create
- name: p2p_advert_info
title: P2P Advert Information
- name: p2p_advert_list
title: P2P Advert List
- name: p2p_advert_update
title: P2P Advert Update
- name: p2p_advertiser_adverts
title: P2P Advertiser Adverts
- name: p2p_advertiser_create
title: P2P Advertiser Create
- name: p2p_advertiser_info
title: P2P Advertiser Information
- name: p2p_advertiser_list
title: P2P Advertiser List
- name: p2p_advertiser_payment_methods
title: P2P Advertiser Payment Methods
- name: p2p_advertiser_relations
title: P2P Advertiser Relations
- name: p2p_advertiser_update
title: P2P Advertiser Update
- name: p2p_chat_create
title: P2P Chat Create
- name: p2p_order_cancel
title: P2P Order Cancel
- name: p2p_order_confirm
title: P2P Order Confirm
- name: p2p_order_create
title: P2P Order Create
- name: p2p_order_dispute
title: P2P Order Dispute
- name: p2p_order_info
title: P2P Order Information
- name: p2p_order_list
title: P2P Order List
- name: p2p_order_review
title: P2P Order Review
- name: p2p_payment_methods
title: P2P Payment Methods
- name: p2p_ping
title: P2P Ping
- name: p2p_settings
title: P2P Settings
- name: payment_methods
title: Payment Methods
- name: paymentagent_create
title: Payment agent create
- name: paymentagent_details
title: Payment agent details
- name: paymentagent_list
title: 'Payment Agent: List'
- name: paymentagent_transfer
title: 'Payment Agent: Transfer'
- name: paymentagent_withdraw
title: 'Payment Agent: Withdraw'
- name: paymentagent_withdraw_justification
title: 'Payment Agent: Withdraw justification'
- name: payout_currencies
title: Payout Currencies
- name: ping
title: Ping
- name: portfolio
title: Portfolio
- name: profit_table
title: Profit Table
- name: proposal
title: Price Proposal
- name: proposal_open_contract
title: 'Price Proposal: Open Contracts'
- name: reality_check
title: Reality Check
- name: residence_list
title: Countries List
- name: revoke_oauth_app
title: Revoke Oauth Application
- name: sell
title: Sell Contract
- name: sell_contract_for_multiple_accounts
title: 'Sell Contracts: Multiple Accounts'
- name: sell_expired
title: Sell Expired Contracts
- name: set_account_currency
title: Set Account Currency
- name: set_financial_assessment
title: Set Financial Assessment
- name: set_self_exclusion
title: Set Self-Exclusion
- name: set_settings
title: Set Account Settings
- name: statement
title: Statement
- name: states_list
title: States List
- name: ticks
title: Ticks Stream
- name: ticks_history
title: Ticks History
- name: time
title: Server Time
- name: tnc_approval
title: Terms and Conditions Approval
- name: topup_virtual
title: Top Up Virtual-Money Account
- name: trading_durations
title: Trading Durations
- name: trading_platform_investor_password_reset
title: 'Trading Platform: Investor Password Reset'
- name: trading_platform_password_reset
title: 'Trading Platform: Password Reset'
- name: trading_servers
title: Server list
- name: trading_times
title: Trading Times
- name: transaction
title: Transactions Stream
- name: transfer_between_accounts
title: Transfer Between Accounts
- name: unsubscribe_email
title: Unsubscribe Email
- name: verify_email
title: Verify Email
- name: verify_email_cellxpert
title: Verify Email Cellxpert
- name: website_status
title: Server Status
4 changes: 2 additions & 2 deletions config/v3/active_symbols/example.json
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"active_symbols": "brief",
"product_type": "basic"
"active_symbols": "brief",
"product_type": "basic"
}
Loading

1 comment on commit 3a6ff98

@vercel
Copy link

@vercel vercel bot commented on 3a6ff98 Oct 11, 2023

Choose a reason for hiding this comment

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

Successfully deployed to the following URLs:

deriv-api-docs – ./

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

Please sign in to comment.