/wazirx-api-postman

WazirX postman collection for spot apis

License: MIT

Wazirx API Postman

Postman is an API Collaboration Platform.

Wazirx now offers several Postman Collections and Environments (JSON files) for a quicker and easier usage of our RESTful APIs.
You only need to import and set up with your own API and secret keys to begin.

How to import and configure

  • Download the wazirx-api-postman repository.

  • Click the Import button. On Postman for Mac, for example, the button is at the top left:

    Screenshot of Postman for Mac, with 'Import' button pointed out at top left.

  • On the Import pop-up page, select the Folder tab. Click the Choose folder from your computer button and choose the root folder of the downloaded repository.

    Screenshot of of Postman for Mac, showing the Import screen.

  • Select which collections and environments you would like to import and click the Import button.

    Screenshot of of Postman for Mac, showing the Import screen after selecting the folder.

  • Select the Environments tab on the left, choose an environment, and set your Api Key and Secret Key by changing the Current Value column (see screenshot); (The Timestamp, Signature, Initial Value fields can be left empty as they’ll be automatically filled by Postman when sending a request.)

    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 eye icon.

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

Postman safety practices

The following practices are advised to secure your account's safety:

  • Don't use Collections obtained from an unknown source.
  • Review the environment JSON file before its usage.
  • 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 finish trying out the API, delete your API keys.

FAQ

Q: Why I can't get any response?

You haven't imported the environment file or you've imported it but haven't selected it from the dropdown menu (mentioned in [[How to import and configure]])

Q: How can I debug a request or find the used URL?

  • Open the Postman's console to find requests' parameters and URL.
  • Debugging can be done by editing the Pre-request Script tab.

Q: Error API-key format invalid.

Likely causes:

  • API key is not set.
  • API key is not correct.
  • X-API-KEY is not selected in your Postman Headers tab.

Q: Error Signature for this request is not valid.

Likely causes:

  • Secret key is not set.
  • Request was made with at least one empty parameter.
  • signature is not the last parameter in the parameters list.

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

Please refer to the API documentation to double check all the mandatory parameters.

My question isn't here

If you don't find your answer here, please email us at api@wazirx.com for similar questions from the community or open an issue here.