Skip to content

Latest commit

 

History

History
69 lines (50 loc) · 4.08 KB

README.md

File metadata and controls

69 lines (50 loc) · 4.08 KB
Raw

Binance API Postman

Postman is an API Collaboration Platform.

Binance now offers several Postman Collections for quick and easy usage of our RESTful APIs.
We also provide a Postman environment (JSON configuration file), which can be conveniently imported for use with your own API and secret keys.

How to import Collections

  • Download the Collections.
  • Import the Collections into the Postman app.

How to import the environment

  • Download the environment JSON file.

  • Open the Postman app.

  • Click the Manage Environments button (gear icon). On Postman for Mac, for example, the button is at the top right of the Postman console:

    Screenshot of Postman for Mac, with 'Manage Environments' button pointed out at top right.

  • On the Manage Environments pop-up page, click Import. Select the environment file you downloaded, then click Add.

    Screenshot of of Postman for Mac, showing the Manage Environments screen after the Spot API environment file is imported.

  • Set your API key and secret key. Please remember to also set the Current Value column (see screenshot); otherwise, Postman will upload into your personal Postman account. (The Timestamp, Signature, Initial Value fields can be left empty. Postman will fill in Initial Value with what you provide in Current Value.)

    Screenshot of Postman for Mac, showing where the user should fill in their API and secret keys.

  • Select your newly-added environment from the environment dropdown menu. On Mac, this is at top right, to the left of the Manage Environments gear icon.

    Screenshot of Postman for Mac, showing how imported environments can be selected from a dropdown .

Guide for using the Binance API with Postman

A guide to using the Binance Spot API Postman Collections can be found here:

https://academy.binance.com/economics/binance-api-series-pt-1-spot-trading-with-postman

Postman safety practices

We suggest that users develop their own applications to work with the Binance Spot API; however, with Postman you can quickly get a feel for each of the API endpoints.

For your safety, please follow these Postman best practices:

  • Don't use Collections obtained from an unknown source.
  • Review the environment JSON file before use.
  • Don't use any code that you don't understand.
  • Make sure that the withdrawal permission is not enabled for your API keys.
  • When you're finished trying out the API, delete your API keys.

FAQ

Error: Could not get any response

You haven't imported the environment file, or you've imported it but haven't selected it from the dropdown. Please follow the the steps above to import and select the environment in Postman.

Error: API-key format invalid.

Likely causes:

  • Your API key is not set.
  • Your API key is not correct.
  • You have not selected X-MBX-APIKEY in your Postman Headers.

Error: Signature for this request is not valid.

Likely causes:

  • You haven't set your secret key.
  • You've selected parameters for which no value was passed. If you aren't using a parameter, uncheck it.

Error: Mandatory parameter 'xxxx' was not sent, was empty/null, or malformed.

Your request is missing a parameter that the API requires. Please refer to the API documentation, and pass all mandatory parameters in your requests.

How can I debug a request, or find the URL it uses?

  • Open the Postman console (CMD/CTRL + ALT + C). Each request will print out its parameters and URL.
  • To debug, edit your Pre-request scripts.

My question isn't here

Please open an issue here.

License

MIT