---
title: "Get API key info"
method: GET
path: "/key/info"
tags: ["Key"]
---

# Get API key info

`GET /key/info`

## Request

- Base URL: `https://api.coinpaprika.com/v1`
- URL: `https://api.coinpaprika.com/v1/key/info`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/coinpaprika/apis/coinpaprika-api/docs/key/info/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns API key information:
* Name of the API key plan
* When the plan started
* A flag indicating if the plan is active
* Link to the API user portal
* Monthly usage

**Available on the following API plans:**
- Starter
- Pro
- Business
- Ultimate
- Enterprise

**Update interval:** Every 1 minute.

## Response `200`

successful operation

- Info
  - `plan` string: Name of the API plan
  - `plan_started_at` string: A date when the plan started in RFC3999 (ISO-8601) format
  - `plan_status` string: Status of the plan. There are 3 possible statuses: `active` - the subscription is active; `past_due` - the subscription payment failed. If payment is not made within 7 days, then the subscription will expire; `inactive` - the subscription is inactive.
  - `portal_url` string: API Customer Portal URL
  - `usage` Usage: Monthly usage for the API key
    - `message` string: `limited plan` if the number of requests is limited in the current plan or `unlimited plan` if there is no limit on the number of requests
    - `current_month` CurrentMonth: Requests made and left stats
      - `requests_made` number: Number of requests made in the current month. If a plan has no limit on the number of requests, e.g., `Enterprise` plan, then the value of `requests_made` is -1
      - `requests_left` number: Number of requests left in the current month. If a plan has no limit on the number of requests, e.g., `Enterprise` plan, then the value of `requests_left` is -1

## Other responses

- `403`: The request could not be processed due to invalid API key
- `429`: too many requests

---

[API](https://skmtc.dev/coinpaprika/apis/coinpaprika-api.md) - [All operations](https://skmtc.dev/coinpaprika/apis/coinpaprika-api/llms.txt) - [OpenAPI document](https://skmtc.dev/coinpaprika/apis/coinpaprika-api/revisions/36a2a796d93f?raw)