README.md

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
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
Wallet, Sub-account	Details on Wallet and sub-accounts endpoints(/sapi)
Margin, BLVT	Details on Margin and BLVT endpoints(/sapi)
Mining	Details on Mining endpoints(/sapi)
BSwap, Savings	Details on BSwap and Savings endpoints(/sapi)
USDT-M Futures	Details on USDT-M Futures API (/fapi)
COIN-M Futures	Details on COIN-M Futures API (/dapi)

FAQ

Name	Description
spot_glossary.md	Definition of terms used in the API
trailing-stop-faq.md	Detailed Information on the behavior of Trailing Stops on the API
stp-faq.md	Detailed Information on the behavior of Self Trade Prevention (aka STP) on the API

Useful Resources

• Postman Collections
  • A postman collection containing the API endpoints for quick and easy use.
  • This is recommended for new users who want to get a quick-start into using the API.
• Connector
  • This is a lightweight library that works as a connector to Binance public API.
  • Python
  • Node.js
  • Ruby
  • DotNET
  • Java
  • Rust
  • PHP
• Swagger
  • A YAML file with OpenApi specification on the RESTful API is available to be used, as well as a Swagger UI page for the consulting.
• 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.