API Frequently Asked Questions
note: this page will be updated as more questions come in.
General
Do you have examples on how to intergrate with your API?
Yes! To make it as easy as possible for our users to develop applications around our API we have compiled a list of examples on how to authenticate a request and published them on Github. If we have missed a language that your application uses then please contact us and we will endeavour to add an example as soon as possible.
Do you provide any pre-built libraries?
Currently we offer a Python library, this can be easily installed via PIP:
pip install bitcoinaverage
For more details please visit: https://pypi.org/project/bitcoinaverage/
Am I able to test endpoints limited to premium plans?
Yes, we understand that before taking out one of our premium plans you may wish to test the responses to ensure certain endpoints meet your application's needs.
To "unlock" an endpoint for testing, simply include this header with your request: "X-testing: testing". You will still be rate limited by IP when using this method
I'm receiving a 401 status code, what does it mean?
It means the request from your application was not correctly authenticated, ensure you have followed all steps correctly in creating the signature, and that it is correctly sent as the header "X-signature".
The signature is only made up of three elements, your public key, private key and timestamp. Check the API Keys section of your user account to ensure the key pair being used is valid.
The timestamp value must be in UTC timezone format, if you are not sure you can check that your local timestamp matches our server by using the endpoint Time Constant. If there is any different/offset please correct this to be within 15 seconds of our server time,or your request will be rejected, this can be automatically managed (and usually is) by a Network Time Protocol daemon (ntpd) on most operating systems
I'm receiving a 429 status code, what does it mean?
If you are returned this status code then you have been rate limited due to making more requests that allowed by your current active plan. Response messages are usually more verbose and will tell you for what reason your requests have been limited.
You are able to monitor your application's request usage by visiting your API Usage page, and of course if you require a larger quota you can Upgrade.
I'm receiving a 403 status code, what does it mean?
Some of our endpoints require a premium plan to use. These include some that return large amounts of data, and some with custom features. Our API Documentation indicates if an endpoint requires a certain plan to access, simply look in the endpoint's section for "Plan: Developer".