Introduction

The Minerstat Coins API surfaces market and profitability metrics for every coin in our dataset. The service requires an authenticated developer account and a valid subscription. Register in the Developer Portal, verify your email, choose a plan, and generate an API key before making requests.

Authorization

Include your API key in the X-API-Key header for every request. A ?key=YOUR_KEY query parameter is available for quick browser tests, but we recommend the header in production. Requests without a valid key return HTTP 401; revoked keys or inactive subscriptions return HTTP 403.

Requirements

• An active developer account.
• An API key created in the API Keys tab of the Developer Portal.
• Compliance with the subscription terms regarding attribution and data usage.

Base URL

Rate limits

Authenticated requests are counted against your monthly subscription quota. In addition, we enforce a rolling edge limit of approximately 12 requests per minute to preserve stability. Coin data refreshes roughly once every minute, so polling more often is unnecessary. When the monthly quota is exceeded the API returns HTTP 402 “Monthly quota exceeded” until the next billing cycle or upgrade.

Responses and error handling

Minerstat APIs use HTTPS and respond with JSON data. Typical error codes include:

• 400 – Invalid parameter
• 401 – Missing or invalid API key
• 402 – Monthly quota exceeded
• 403 – Subscription not active or key revoked
• 404 – Non-existent content
• 500 – API/System error