Skip to main content
Paid Feature — Requires a valid API keyGet API key · Set API key

​
Overview

Retrieve information about your API key, including plan details and usage statistics.

​
Usage

coinpaprika-cli key-info

​
Options

​
--output
string
default:"table"
Output format: table or json
​
--raw
boolean
default:"false"
JSON output without _meta wrapper (for scripts/piping)

​
Examples

​
Check key status

coinpaprika-cli key-info

​
JSON output for monitoring

coinpaprika-cli key-info --output json

​
Script to check remaining credits

#!/bin/bash
usage=$(coinpaprika-cli key-info --output json --raw | jq -r '.usage')
echo "API usage: $usage"

​
Response Fields

​
plan
string
Your current subscription plan (e.g., “Starter”, “Business”, “Enterprise”)
​
usage
object
Usage statistics for your API key (structure varies by plan)
​
message
string
Additional information or warnings about your account

​
API Endpoint

GET https://api-pro.coinpaprika.com/v1/key/info
Headers: 
Authorization: <your-api-key>

​
Error Messages

No API key configuredIf you see this error, you need to set up your API key first:
coinpaprika-cli config set-key <YOUR_KEY>
Or use the onboarding wizard:
coinpaprika-cli onboard

​
Setting Your API Key

There are three ways to provide your API key:
1

Config file (recommended)

coinpaprika-cli config set-key <YOUR_KEY>
Saves to ~/.config/coinpaprika-cli/config.toml
2

Environment variable

export COINPAPRIKA_API_KEY=<YOUR_KEY>
coinpaprika-cli key-info
3

Command line flag

coinpaprika-cli key-info --api-key <YOUR_KEY>

config

Manage CLI configuration

plans

View pricing plans

​
Notes

  • Free tier users don’t need an API key (20,000 calls/month)
  • Key info is cached for 5 minutes to avoid unnecessary API calls
  • Usage statistics update in near real-time
  • Contact support if usage numbers seem incorrect

Build docs developers (and LLMs) love

Get started for freeTalk to us