Making requests

API url

Here is the HTTP REST service https://api.cryptosteroid.com (opens in a new tab)

Current API version: 1.0

Base path: /v1

Request/Response

All requests and responses use the application/json content type and follow typical HTTP response status codes for success and failure.

Errors

Unless otherwise stated, errors in bad requests will respond with HTTP 4xx status codes. The response body will also contain a message parameter indicating the cause. Your HTTP library should be configured to provide message bodies for non-2xx responses so that you can read the message field from the body.

Success

A successful response is indicated by HTTP status codes 200 or 201 and may contain an optional body. If the response includes a body, it is documented under each resource below. The response data can be found in the result field.

Common status codes

CodeReason
200OK - Data extracted successfully
201Created - Object created successfully
400Bad Request - Invalid request format
401Unauthorized - Invalid API key
403Forbidden - You do not have access to the requested resource
404Not Found - The requested resource was not found