GET
/
api
/
v1
/
rankings
/
statistics
curl --request GET \
  --url https://api.international.coinbase.com/api/v1/rankings/statistics \
  --header 'CB-ACCESS-KEY: <api-key>' \
  --header 'CB-ACCESS-PASSPHRASE: <api-key>' \
  --header 'CB-ACCESS-SIGN: <api-key>' \
  --header 'CB-ACCESS-TIMESTAMP: <api-key>'
{
  "last_updated": "2023-01-29T14:32:28.000Z",
  "statistics": {
    "maker": {
      "rank": 1,
      "relative_percent": 30,
      "volume": 1000000
    },
    "taker": {
      "rank": 1,
      "relative_percent": 30,
      "volume": 1000000
    },
    "total": {
      "rank": 1,
      "relative_percent": 30,
      "volume": 1000000
    }
  }
}
const rankingsService = new RankingsService(client);

rankingsService.getRankings().then(async (response) => {
    console.log('Volume Rankings: ', response);
})

For more information, please visit the INTX TS SDK.

Authorizations

​
CB-ACCESS-KEY
string
header
required

The Client ID that owns the API Key for the request

​
CB-ACCESS-PASSPHRASE
string
header
required

The pass phrase affiliated with the API Key

​
CB-ACCESS-SIGN
string
header
required

A HMAC SHA-256 signature using the API Key secret on the string TIMESTAMP, METHOD, REQUEST_PATH, BODY

​
CB-ACCESS-TIMESTAMP
string
header
required

The timestamp of when the request is being made

Query Parameters

​
instrument_type
enum<string>
required

Identifies the instruments by type . Allowed values: SPOT, PERPETUAL_FUTURE

Available options:
SPOT,
PERPETUAL_FUTURE
​
period
enum<string>

Identifies the lookback window for the query . Allowed values: YESTERDAY, LAST_7_DAYS, THIS_MONTH, LAST_30_DAYS, LAST_MONTH. Default: THIS_MONTH

Available options:
YESTERDAY,
LAST_7_DAYS,
THIS_MONTH,
LAST_30_DAYS,
LAST_MONTH
​
instruments
string

One or more instrument identifiers, such as name (e.g., BTC-USDC), UUID (e.g., ce55a827-f04a-45c0-9d9b-8bbdb9b48065), or instrument ID (e.g., 7149252043835013). If not provided, the query will return the rankings for all instruments of the specified type. If one or more instruments are specified, the query will return the volume and relative percent for all specified instruments, but the returned rank will be "--".

Response

200
application/json

Ranking information

The response is of type object.