What is RESTful API?
A RESTful API is an application program interface (API) that uses HTTP requests to GET, PUT, POST and DELETE data. A RESTful API is based on representational state transfer (REST) technology, an architectural style, and approach to communications often used in web services development.
Overview
The Apirone bitcoin REST API uses HTTP methods and a RESTful endpoint structure.
You have to format requests in JSON and the APIs return JSON-formatted responses.
All requests over secure HTTPS protocol only.
To construct a REST call, combine:
- The HTTP method
- The full URI to the resource
- HTTP headers, if required
- The JSON-formatted payload, if required
The REST API endpoint URL: https://apirone.com/api/
Errors
Apirone uses standard HTTP status codes when returning errors.
Additionally, we provide details about errors in the body of the response.
HTTP status codes:
| 200 | OK. | The request is successful. |
| 400 | Bad Request. | The request contains an invalid parameter or value |
| 401 | Unauthorized. | Authentication credentials were missing or invalid. |
| 404 | Not Found. | The requested resource could not be found. |
| 409 | Conflict. | The operation was aborted due to a conflict. |
| 429 | Too Many Request. | Too many requests were sent in a given period of time. Retry the request after some delay. |
| 500 | Internal Server Error. | Internal Server Error. |
| 503 | Service Unavailable. | The server is currently unavailable. |