Skip to content

Latest commit

 

History

History
92 lines (81 loc) · 6.39 KB

README.md

File metadata and controls

92 lines (81 loc) · 6.39 KB

Official Documentation for the Binance APIs and Streams.

  • Official Announcements regarding changes, downtime, etc. to the API and Streams will be reported here: https://t.me/binance_api_announcements
  • Streams, endpoints, parameters, payloads, etc. described in the documents in this repository are considered official and supported.
  • The use of any other streams, endpoints, parameters, or payloads, etc. is not supported; use them at your own risk and with no guarantees.
Name Description
enums.md Details on the enums used by REST and WebSocket API
errors.md Error codes and messages of Spot API
filters.md Details on the filters used by Spot API
rest-api.md Spot REST API (/api)
web-socket-api.md Spot WebSocket API
web-socket-streams.md Spot Market Data WebSocket streams
user-data-stream.md Spot User Data WebSocket streams
sbe_schemas Spot Simple Binary Encoding (SBE) schemas
testnet API docs for features available only on SPOT Testnet
Margin Trading Details on Margin Trading
Derivative UM Futures Details on Derivative UM Futures (/fapi)
Derivative CM Futures Details on Derivative CM Futures (/dapi)
Derivative Options Details on Derivative European Options (/eapi)
Derivative Portfolio Margin Details on Derivative Portfolio Margin (/papi)
Wallet Details on Wallet endpoints (/sapi)
Sub Account Details on Sub-Account requests (/sapi)
Simple Earn Details on Simple Earn
Dual Investment Details on Dual Investment
Auto Invest Details on Auto Invest
Staking Details on Staking
Mining Details on Mining
Algo Trading Details on Algo Trading
Copy Trading Details on Copy Trading
Porfolio Margin Pro Details on Portfolio Margin Pro
Fiat Details on Fiat
C2C Details on C2C
VIP Loan Details on VIP Loan
Crypto Loan Details on Crypto Loan
Pay Details on Binance Pay
Convert Details on Convert API
Rebate Details on Spot Rebate
NFT Details on NFT requests
Gift Card Details on Gift Card API

FAQ

Name Description
spot_glossary Definition of terms used in the API
commissions_faq Explaining commission calculations on the API
trailing-stop-faq Detailed Information on the behavior of Trailing Stops on the API
stp_faq Detailed Information on the behavior of Self Trade Prevention (aka STP) on the API
market-data-only Information on our market data only API and websocket streams.
sor_faq Smart Order Routing (SOR)
order_count_decrement Updates to the Spot Order Count Limit Rules.
sbe_faq Information on the implementation of Simple Binary Encoding (SBE) on the API

Change log

Please refer to CHANGELOG for latest changes on our APIs (both REST and WebSocket) and Streamers.

Useful Resources

  • Postman Collections
    • Postman collections are available, and they are recommended for new users seeking a quick and easy start with the API.
  • Connectors
  • Swagger
    • A YAML file with OpenAPI specification for the RESTful API is available, along with a Swagger UI page for reference.
  • Spot Testnet
    • Users can use the SPOT Testnet to practice SPOT trading.
    • Currently, this is only available via the API.
    • Only endpoints starting with /api/* are supported, /sapi/* is not supported.

Contact Us

  • Binance API Telegram Group
    • For any questions regarding sudden drop in performance with the API and/or Websockets.
    • For any general questions about the API not covered in the documentation.
  • Binance Developers
    • For any questions/help regarding code implementation with API and/or Websockets.
  • Binance Customer Support
    • For cases such as missing funds, help with 2FA, etc.