API

Every tokenmetrics.api.* operation is listed below with parameter shapes and return types from the plugin Zod schemas.

New to Corsair? See API access, authentication, and error handling.

Market

getPrice

market.getPrice Retrieve token price, volume, and market-cap data Risk: read

await corsair.tokenmetrics.api.market.getPrice({});

Input

Name	Type	Required	Description
`token_id`	`string \| number`	No	—
`symbol`	`string`	No	—
`interval`	`string`	No	—
`startDate`	`string`	No	—
`endDate`	`string`	No	—
`limit`	`number`	No	—
`page`	`number`	No	—

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—
`success`	`boolean`	No	—
`message`	`string`	No	—

data full type

{
  token_id?: string | number,
  symbol?: string,
  name?: string,
  price?: number,
  market_cap?: number,
  volume_24h?: number | null,
  number_of_holders?: number | null,
  token_creation_date?: string
}[]

getTopMarketCap

market.getTopMarketCap List tokens ranked by market capitalization Risk: read

await corsair.tokenmetrics.api.market.getTopMarketCap({});

Input

Name	Type	Required	Description
`top_k`	`number`	No	—
`page`	`number`	No	—

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—
`success`	`boolean`	No	—
`message`	`string`	No	—

data full type

{
  token_id?: string | number,
  symbol?: string,
  name?: string,
  price?: number,
  market_cap?: number,
  volume_24h?: number | null,
  number_of_holders?: number | null,
  token_creation_date?: string
}[]

Technical

getIndicators

technical.getIndicators Retrieve a technical indicator for a token and interval Risk: read

await corsair.tokenmetrics.api.technical.getIndicators({});

Input

Name	Type	Required	Description
`symbol`	`string`	Yes	—
`interval`	`string`	Yes	—
`indicator`	`string`	Yes	—
`startDate`	`string`	No	—
`endDate`	`string`	No	—

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—
`success`	`boolean`	No	—
`message`	`string`	No	—

data full type

{
  symbol?: string,
  indicator?: string,
  value?: number,
  datetime?: string
}[]

Tokens

list

tokens.list List supported tokens and their identifiers Risk: read

await corsair.tokenmetrics.api.tokens.list({});

Input

Name	Type	Required	Description
`token_id`	`string \| number`	No	—
`symbol`	`string`	No	—
`category`	`string`	No	—
`exchange`	`string`	No	—
`marketcap`	`number`	No	—
`volume`	`number`	No	—
`fdv`	`number`	No	—
`limit`	`number`	No	—
`page`	`number`	No	—

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—
`success`	`boolean`	No	—
`message`	`string`	No	—

data full type

{
  token_id?: string | number,
  symbol?: string,
  name?: string,
  price?: number,
  market_cap?: number,
  volume_24h?: number | null,
  number_of_holders?: number | null,
  token_creation_date?: string
}[]

Trading

getSignals

trading.getSignals Retrieve AI-generated token entry and exit signals Risk: read

await corsair.tokenmetrics.api.trading.getSignals({});

Input

Name	Type	Required	Description
`token_id`	`string \| number`	No	—
`symbol`	`string`	No	—
`startDate`	`string`	No	—
`endDate`	`string`	No	—
`category`	`string`	No	—
`exchange`	`string`	No	—
`marketcap`	`number`	No	—
`volume`	`number`	No	—
`fdv`	`number`	No	—
`signal`	`-1 \| 0 \| 1`	No	—
`limit`	`number`	No	—
`page`	`number`	No	—

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—
`success`	`boolean`	No	—
`message`	`string`	No	—

data full type

{
  token_id?: string | number,
  symbol?: string,
  signal?: number,
  date?: string
}[]

Overview

Plugins

Market

getPrice

getTopMarketCap

Technical

getIndicators

Tokens

list

Trading

getSignals

​Market

​getPrice

​getTopMarketCap

​Technical

​getIndicators

​Tokens

​list

​Trading

​getSignals

Market

getPrice

getTopMarketCap

Technical

getIndicators

Tokens

list

Trading

getSignals