KosmoKrator

data

CoinMarketCap Lua API for KosmoKrator Agents

Agent-facing Lua documentation and function reference for the CoinMarketCap KosmoKrator integration.

Lua Namespace

Agents call this integration through app.integrations.coinmarketcap.*. Use lua_read_doc("integrations.coinmarketcap") inside KosmoKrator to discover the same reference at runtime.

Call Lua from the Headless CLI

Use kosmo integrations:lua when a shell script, CI job, cron job, or another coding CLI should run a deterministic CoinMarketCap workflow without starting an interactive agent session.

Inline Lua call 
kosmo integrations:lua --eval 'dump(app.integrations.coinmarketcap.airdrop({id = "example_id"}))' --json
Read Lua docs headlessly 
kosmo integrations:lua --eval 'print(docs.read("coinmarketcap"))' --json
kosmo integrations:lua --eval 'print(docs.read("coinmarketcap.airdrop"))' --json

Workflow file

Put repeatable logic in a Lua file, then execute it with JSON output for the calling process.

workflow.lua 
local coinmarketcap = app.integrations.coinmarketcap
local result = coinmarketcap.airdrop({id = "example_id"})

dump(result)
Run the workflow 
kosmo integrations:lua workflow.lua --json
kosmo integrations:lua workflow.lua --force --json
Namespace note. integrations:lua exposes app.integrations.coinmarketcap, app.mcp.*, docs.*, json.*, and regex.*. Use app.integrations.coinmarketcap.default.* or app.integrations.coinmarketcap.work.* when you configured named credential accounts.

MCP-only Lua

If the script only needs configured MCP servers and does not need CoinMarketCap, use the narrower mcp:lua command.

MCP Lua command 
# Use mcp:lua for MCP-only scripts; use integrations:lua for this integration namespace.
kosmo mcp:lua --eval 'dump(mcp.servers())' --json

Agent-Facing Lua Docs

This is the rendered version of the full Lua documentation exposed to agents when they inspect the integration namespace.

CoinMarketCap Integration

Use the coinmarketcap integration to fetch cryptocurrency market data, listings, quotes, metadata, OHLCV history, exchange data, global metrics, DEX token and pair data, holder analytics, content, community trends, CMC indices, and utility endpoints.

This package is generated from CoinMarketCap’s official API documentation and endpoint-level API Summary blocks. It exposes 91 CoinMarketCap Pro API operations across market data, DEX data, utilities, and documented deprecated compatibility endpoints.

Authentication

Set api_key to a CoinMarketCap Pro API key. Requests send X-CMC_PRO_API_KEY, Accept: application/json, and Accept-Encoding: deflate, gzip to https://pro-api.coinmarketcap.com by default.

Request Shape

Query parameters are exposed as snake_case tool parameters using the official API summary names. POST endpoints also accept a body object matching the CoinMarketCap endpoint schema. Comma-separated CoinMarketCap parameters such as id, symbol, slug, convert, and aux should be passed as strings exactly as documented by CoinMarketCap.

Return Shape

Responses are returned as decoded JSON from CoinMarketCap. Successful responses usually contain data and status; API errors are converted to tool errors using status.error_message when available.

Examples

local quotes = app.integrations.coinmarketcap.get_v3_cryptocurrency_quotes_latest({
  symbol = "BTC,ETH",
  convert = "USD"
})

local listings = app.integrations.coinmarketcap.get_v3_cryptocurrency_listings_latest({
  start = 1,
  limit = 10,
  convert = "USD"
})

local key = app.integrations.coinmarketcap.get_v1_key_info({})

Use fake API keys and public asset symbols in tests and examples. Never store real CoinMarketCap API keys, customer account metadata, or paid-plan response snapshots in fixtures or Lua examples.

Raw agent markdown 
# CoinMarketCap Integration

Use the `coinmarketcap` integration to fetch cryptocurrency market data, listings, quotes, metadata, OHLCV history, exchange data, global metrics, DEX token and pair data, holder analytics, content, community trends, CMC indices, and utility endpoints.

This package is generated from CoinMarketCap's official API documentation and endpoint-level API Summary blocks. It exposes 91 CoinMarketCap Pro API operations across market data, DEX data, utilities, and documented deprecated compatibility endpoints.

## Authentication

Set `api_key` to a CoinMarketCap Pro API key. Requests send `X-CMC_PRO_API_KEY`, `Accept: application/json`, and `Accept-Encoding: deflate, gzip` to `https://pro-api.coinmarketcap.com` by default.

## Request Shape

Query parameters are exposed as snake_case tool parameters using the official API summary names. POST endpoints also accept a `body` object matching the CoinMarketCap endpoint schema. Comma-separated CoinMarketCap parameters such as `id`, `symbol`, `slug`, `convert`, and `aux` should be passed as strings exactly as documented by CoinMarketCap.

## Return Shape

Responses are returned as decoded JSON from CoinMarketCap. Successful responses usually contain `data` and `status`; API errors are converted to tool errors using `status.error_message` when available.

## Examples

```lua
local quotes = app.integrations.coinmarketcap.get_v3_cryptocurrency_quotes_latest({
  symbol = "BTC,ETH",
  convert = "USD"
})

local listings = app.integrations.coinmarketcap.get_v3_cryptocurrency_listings_latest({
  start = 1,
  limit = 10,
  convert = "USD"
})

local key = app.integrations.coinmarketcap.get_v1_key_info({})
```

Use fake API keys and public asset symbols in tests and examples. Never store real CoinMarketCap API keys, customer account metadata, or paid-plan response snapshots in fixtures or Lua examples.
Metadata-derived Lua example 
local result = app.integrations.coinmarketcap.airdrop({id = "example_id"})
print(result)

Functions

airdrop Read

Fetch the complete documentation index at: https://pro.coinmarketcap.com/llms.txt Official CoinMarketCap endpoint: GET /v1/cryptocurrency/airdrop.

Lua path
app.integrations.coinmarketcap.airdrop
Full name
coinmarketcap.coinmarketcap_get_v1_cryptocurrency_airdrop
ParameterTypeRequiredDescription
id string yes Airdrop Unique ID. This can be found using the Airdrops API.
airdrops Read

Fetch the complete documentation index at: https://pro.coinmarketcap.com/llms.txt Official CoinMarketCap endpoint: GET /v1/cryptocurrency/airdrops.

Lua path
app.integrations.coinmarketcap.airdrops
Full name
coinmarketcap.coinmarketcap_get_v1_cryptocurrency_airdrops
ParameterTypeRequiredDescription
start integer no Optionally offset the start (1-based index) of the paginated list of items to return.
limit integer no Optionally specify the number of results to return. Use this parameter and the "start" parameter to determine your own pagination size.
status string no What status of airdrops.
id string no Filtered airdrops by one cryptocurrency CoinMarketCap IDs. Example: 1
slug string no Alternatively filter airdrops by a cryptocurrency slug. Example: "bitcoin"
symbol string no Alternatively filter airdrops one cryptocurrency symbol. Example: "BTC".
categories Read

Fetch the complete documentation index at: https://pro.coinmarketcap.com/llms.txt Official CoinMarketCap endpoint: GET /v1/cryptocurrency/categories.

Lua path
app.integrations.coinmarketcap.categories
Full name
coinmarketcap.coinmarketcap_get_v1_cryptocurrency_categories
ParameterTypeRequiredDescription
start integer no Optionally offset the start (1-based index) of the paginated list of items to return.
limit integer no Optionally specify the number of results to return. Use this parameter and the "start" parameter to determine your own pagination size.
id string no Filtered categories by one or more comma-separated cryptocurrency CoinMarketCap IDs. Example: 1,2
slug string no Alternatively filter categories by a comma-separated list of cryptocurrency slugs. Example: "bitcoin,ethereum"
symbol string no Alternatively filter categories one or more comma-separated cryptocurrency symbols. Example: "BTC,ETH".
category Read

Fetch the complete documentation index at: https://pro.coinmarketcap.com/llms.txt Official CoinMarketCap endpoint: GET /v1/cryptocurrency/category.

Lua path
app.integrations.coinmarketcap.category
Full name
coinmarketcap.coinmarketcap_get_v1_cryptocurrency_category
ParameterTypeRequiredDescription
id string yes The Category ID. This can be found using the Categories API.
start integer no Optionally offset the start (1-based index) of the paginated list of coins to return.
limit integer no Optionally specify the number of coins to return. Use this parameter and the "start" parameter to determine your own pagination size.
convert string no Optionally calculate market quotes in up to 120 currencies at once by passing a comma-separated list of cryptocurrency or fiat currency symbols. Each additional convert option beyond the first requires an additional call credit. A list of supported fiat options can be found [here](/guides/standards-and-conventions). Each conversion is returned in its own "quote" object.
convert_id string no Optionally calculate market quotes by CoinMarketCap ID instead of symbol. This option is identical to `convert` outside of ID format. Ex: convert_id=1,2781 would replace convert=BTC,USD in your query. This parameter cannot be used when `convert` is used.
id_map Read

Fetch the complete documentation index at: https://pro.coinmarketcap.com/llms.txt Official CoinMarketCap endpoint: GET /v1/cryptocurrency/map.

Lua path
app.integrations.coinmarketcap.id_map
Full name
coinmarketcap.coinmarketcap_get_v1_cryptocurrency_map
ParameterTypeRequiredDescription
listing_status string no Only active cryptocurrencies are returned by default. Pass `inactive` to get a list of cryptocurrencies that are no longer active. Pass `untracked` to get a list of cryptocurrencies that are listed but do not yet meet methodology requirements to have tracked markets available. You may pass one or more comma-separated values.
start integer no Optionally offset the start (1-based index) of the paginated list of items to return.
limit integer no Optionally specify the number of results to return. Use this parameter and the "start" parameter to determine your own pagination size.
sort string no What field to sort the list of cryptocurrencies by.
symbol string no Optionally pass a comma-separated list of cryptocurrency symbols to return CoinMarketCap IDs for. If this option is passed, other options will be ignored.
aux string no Optionally specify a comma-separated list of supplemental data fields to return. Pass `platform,first_historical_data,last_historical_data,is_active,status` to include all auxiliary fields.
cryptocurrency_metadata Read

Fetch the complete documentation index at: https://pro.coinmarketcap.com/llms.txt Official CoinMarketCap endpoint: GET /v2/cryptocurrency/info.

Lua path
app.integrations.coinmarketcap.cryptocurrency_metadata
Full name
coinmarketcap.coinmarketcap_get_v2_cryptocurrency_info
ParameterTypeRequiredDescription
id string no One or more comma-separated CoinMarketCap cryptocurrency IDs. Example: "1,2"
slug string no Alternatively pass a comma-separated list of cryptocurrency slugs. Example: "bitcoin,ethereum"
symbol string no Alternatively pass one or more comma-separated cryptocurrency symbols. Example: "BTC,ETH". At least one "id" *or* "slug" *or* "symbol" is required for this request. Please note that starting in the v2 endpoint, due to the fact that a symbol is not unique, if you request by symbol each data response will contain an array of objects containing all of the coins that use each requested symbol. The v1 endpoint will still return a single object, the highest ranked coin using that symbol.
address string no Alternatively pass in a contract address. Example: "0xc40af1e4fecfa05ce6bab79dcd8b373d2e436c4e"
skip_invalid boolean no Pass `true` to relax request validation rules. When requesting records on multiple cryptocurrencies an error is returned if any invalid cryptocurrencies are requested or a cryptocurrency does not have matching records in the requested timeframe. If set to true, invalid lookups will be skipped allowing valid cryptocurrencies to still be returned.
aux string no Optionally specify a comma-separated list of supplemental data fields to return. Pass `urls,logo,description,tags,platform,date_added,notice,status` to include all auxiliary fields.
listings_historical Read

Fetch the complete documentation index at: https://pro.coinmarketcap.com/llms.txt Official CoinMarketCap endpoint: GET /v1/cryptocurrency/listings/historical.

Lua path
app.integrations.coinmarketcap.listings_historical
Full name
coinmarketcap.coinmarketcap_get_v1_cryptocurrency_listings_historical
ParameterTypeRequiredDescription
date string yes date (Unix or ISO 8601) to reference day of snapshot.
start integer no Optionally offset the start (1-based index) of the paginated list of items to return.
limit integer no Optionally specify the number of results to return. Use this parameter and the "start" parameter to determine your own pagination size.
convert string no Optionally calculate market quotes in up to 120 currencies at once by passing a comma-separated list of cryptocurrency or fiat currency symbols. Each additional convert option beyond the first requires an additional call credit. A list of supported fiat options can be found [here](/guides/standards-and-conventions). Each conversion is returned in its own "quote" object.
convert_id string no Optionally calculate market quotes by CoinMarketCap ID instead of symbol. This option is identical to `convert` outside of ID format. Ex: convert_id=1,2781 would replace convert=BTC,USD in your query. This parameter cannot be used when `convert` is used.
sort string no What field to sort the list of cryptocurrencies by.
sort_dir string no The direction in which to order cryptocurrencies against the specified sort.
cryptocurrency_type string no The type of cryptocurrency to include.
aux string no Optionally specify a comma-separated list of supplemental data fields to return. Pass `platform,tags,date_added,circulating_supply,total_supply,max_supply,cmc_rank,num_market_pairs` to include all auxiliary fields.
listings_latest Read

Fetch the complete documentation index at: https://pro.coinmarketcap.com/llms.txt Official CoinMarketCap endpoint: GET /v1/cryptocurrency/listings/latest.

Lua path
app.integrations.coinmarketcap.listings_latest
Full name
coinmarketcap.coinmarketcap_get_v1_cryptocurrency_listings_latest
ParameterTypeRequiredDescription
start integer no Optionally offset the start (1-based index) of the paginated list of items to return.
limit integer no Optionally specify the number of results to return. Use this parameter and the "start" parameter to determine your own pagination size.
price_min number no Optionally specify a threshold of minimum USD price to filter results by.
price_max number no Optionally specify a threshold of maximum USD price to filter results by.
market_cap_min number no Optionally specify a threshold of minimum market cap to filter results by.
market_cap_max number no Optionally specify a threshold of maximum market cap to filter results by.
volume_24h_min number no Optionally specify a threshold of minimum 24 hour USD volume to filter results by.
volume_24h_max number no Optionally specify a threshold of maximum 24 hour USD volume to filter results by.
circulating_supply_min number no Optionally specify a threshold of minimum circulating supply to filter results by.
circulating_supply_max number no Optionally specify a threshold of maximum circulating supply to filter results by.
percent_change_24h_min number no Optionally specify a threshold of minimum 24 hour percent change to filter results by.
percent_change_24h_max number no Optionally specify a threshold of maximum 24 hour percent change to filter results by.
self_reported_circulating_supply_min number no Optionally specify a threshold of minimum self reported circulating supply to filter results by.
self_reported_circulating_supply_max number no Optionally specify a threshold of maximum self reported circulating supply to filter results by.
self_reported_market_cap_min number no Optionally specify a threshold of minimum self reported market cap to filter results by.
self_reported_market_cap_max number no Optionally specify a threshold of maximum self reported market cap to filter results by.
unlocked_market_cap_min number no Optionally specify a threshold of minimum unlocked market cap to filter results by.
unlocked_market_cap_max number no Optionally specify a threshold of maximum unlocked market cap to filter results by.
unlocked_circulating_supply_min number no Optionally specify a threshold of minimum unlocked circulating supply to filter results by.
unlocked_circulating_supply_max number no Optionally specify a threshold of maximum unlocked circulating supply to filter results by.
convert string no Optionally calculate market quotes in up to 120 currencies at once by passing a comma-separated list of cryptocurrency or fiat currency symbols. Each additional convert option beyond the first requires an additional call credit. A list of supported fiat options can be found [here](/guides/standards-and-conventions). Each conversion is returned in its own "quote" object.
convert_id string no Optionally calculate market quotes by CoinMarketCap ID instead of symbol. This option is identical to `convert` outside of ID format. Ex: convert_id=1,2781 would replace convert=BTC,USD in your query. This parameter cannot be used when `convert` is used.
sort string no What field to sort the list of cryptocurrencies by.
sort_dir string no The direction in which to order cryptocurrencies against the specified sort.
cryptocurrency_type string no The type of cryptocurrency to include.
tag string no The tag of cryptocurrency to include.
aux string no Optionally specify a comma-separated list of supplemental data fields to return. Pass `num_market_pairs,cmc_rank,date_added,tags,platform,max_supply,circulating_supply,total_supply,market_cap_by_total_supply,volume_24h_reported,volume_7d,volume_7d_reported,volume_30d,volume_30d_reported,is_market_cap_included_in_calc` to include all auxiliary fields.
listings_new Read

Fetch the complete documentation index at: https://pro.coinmarketcap.com/llms.txt Official CoinMarketCap endpoint: GET /v1/cryptocurrency/listings/new.

Lua path
app.integrations.coinmarketcap.listings_new
Full name
coinmarketcap.coinmarketcap_get_v1_cryptocurrency_listings_new
ParameterTypeRequiredDescription
start integer no Optionally offset the start (1-based index) of the paginated list of items to return.
limit integer no Optionally specify the number of results to return. Use this parameter and the "start" parameter to determine your own pagination size.
convert string no Optionally calculate market quotes in up to 120 currencies at once by passing a comma-separated list of cryptocurrency or fiat currency symbols. Each additional convert option beyond the first requires an additional call credit. A list of supported fiat options can be found [here](/guides/standards-and-conventions). Each conversion is returned in its own "quote" object.
convert_id string no Optionally calculate market quotes by CoinMarketCap ID instead of symbol. This option is identical to `convert` outside of ID format. Ex: convert_id=1,2781 would replace convert=BTC,USD in your query. This parameter cannot be used when `convert` is used.
sort_dir string no The direction in which to order cryptocurrencies against the specified sort.
cryptocurrency_pairs_latest Read

Fetch the complete documentation index at: https://pro.coinmarketcap.com/llms.txt Official CoinMarketCap endpoint: GET /v2/cryptocurrency/market-pairs/latest.

Lua path
app.integrations.coinmarketcap.cryptocurrency_pairs_latest
Full name
coinmarketcap.coinmarketcap_get_v2_cryptocurrency_market_pairs_latest
ParameterTypeRequiredDescription
id string no A cryptocurrency or fiat currency by CoinMarketCap ID to list market pairs for. Example: "1"
slug string no Alternatively pass a cryptocurrency by slug. Example: "bitcoin"
symbol string no Alternatively pass a cryptocurrency by symbol. Fiat currencies are not supported by this field. Example: "BTC". A single cryptocurrency "id", "slug", *or* "symbol" is required.
start integer no Optionally offset the start (1-based index) of the paginated list of items to return.
limit integer no Optionally specify the number of results to return. Use this parameter and the "start" parameter to determine your own pagination size.
sort_dir string no Optionally specify the sort direction of markets returned.
sort string no Optionally specify the sort order of markets returned. By default we return a strict sort on 24 hour reported volume. Pass `cmc_rank` to return a CMC methodology based sort where markets with excluded volumes are returned last.
aux string no Optionally specify a comma-separated list of supplemental data fields to return. Pass `num_market_pairs,category,fee_type,market_url,currency_name,currency_slug,price_quote,notice,cmc_rank,effective_liquidity,market_score,market_reputation` to include all auxiliary fields.
matched_id string no Optionally include one or more fiat or cryptocurrency IDs to filter market pairs by. For example `?id=1&matched_id=2781` would only return BTC markets that matched: "BTC/USD" or "USD/BTC". This parameter cannot be used when `matched_symbol` is used.
matched_symbol string no Optionally include one or more fiat or cryptocurrency symbols to filter market pairs by. For example `?symbol=BTC&matched_symbol=USD` would only return BTC markets that matched: "BTC/USD" or "USD/BTC". This parameter cannot be used when `matched_id` is used.
category string no The category of trading this market falls under. Spot markets are the most common but options include derivatives and OTC.
fee_type string no The fee type the exchange enforces for this market.
convert string no Optionally calculate market quotes in up to 120 currencies at once by passing a comma-separated list of cryptocurrency or fiat currency symbols. Each additional convert option beyond the first requires an additional call credit. A list of supported fiat options can be found [here](/guides/standards-and-conventions). Each conversion is returned in its own "quote" object.
convert_id string no Optionally calculate market quotes by CoinMarketCap ID instead of symbol. This option is identical to `convert` outside of ID format. Ex: convert_id=1,2781 would replace convert=BTC,USD in your query. This parameter cannot be used when `convert` is used.
ohlcv_historical Read

Fetch the complete documentation index at: https://pro.coinmarketcap.com/llms.txt Official CoinMarketCap endpoint: GET /v2/cryptocurrency/ohlcv/historical.

Lua path
app.integrations.coinmarketcap.ohlcv_historical
Full name
coinmarketcap.coinmarketcap_get_v2_cryptocurrency_ohlcv_historical
ParameterTypeRequiredDescription
id string no One or more comma-separated CoinMarketCap cryptocurrency IDs. Example: "1,1027"
slug string no Alternatively pass a comma-separated list of cryptocurrency slugs. Example: "bitcoin,ethereum"
symbol string no Alternatively pass one or more comma-separated cryptocurrency symbols. Example: "BTC,ETH". At least one "id" *or* "slug" *or* "symbol" is required for this request.
time_period string no Time period to return OHLCV data for. The default is "daily". If hourly, the open will be 01:00 and the close will be 01:59. If daily, the open will be 00:00:00 for the day and close will be 23:59:99 for the same day. See the main endpoint description for details.
time_start string no Timestamp (Unix or ISO 8601) to start returning OHLCV time periods for. Only the date portion of the timestamp is used for daily OHLCV so it's recommended to send an ISO date format like "2018-09-19" without time.
time_end string no Timestamp (Unix or ISO 8601) to stop returning OHLCV time periods for (inclusive). Optional, if not passed we'll default to the current time. Only the date portion of the timestamp is used for daily OHLCV so it's recommended to send an ISO date format like "2018-09-19" without time.
count number no Optionally limit the number of time periods to return results for. The default is 10 items. The current query limit is 10000 items.
interval string no Optionally adjust the interval that "time_period" is sampled. For example with interval=monthly&time_period=daily you will see a daily OHLCV record for January, February, March and so on. See main endpoint description for available options.
convert string no By default market quotes are returned in USD. Optionally calculate market quotes in up to 3 fiat currencies or cryptocurrencies.
convert_id string no Optionally calculate market quotes by CoinMarketCap ID instead of symbol. This option is identical to `convert` outside of ID format. Ex: convert_id=1,2781 would replace convert=BTC,USD in your query. This parameter cannot be used when `convert` is used.
skip_invalid boolean no Pass `true` to relax request validation rules. When requesting records on multiple cryptocurrencies an error is returned if any invalid cryptocurrencies are requested or a cryptocurrency does not have matching records in the requested timeframe. If set to true, invalid lookups will be skipped allowing valid cryptocurrencies to still be returned.
ohlcv_latest Read

Fetch the complete documentation index at: https://pro.coinmarketcap.com/llms.txt Official CoinMarketCap endpoint: GET /v2/cryptocurrency/ohlcv/latest.

Lua path
app.integrations.coinmarketcap.ohlcv_latest
Full name
coinmarketcap.coinmarketcap_get_v2_cryptocurrency_ohlcv_latest
ParameterTypeRequiredDescription
id string no One or more comma-separated cryptocurrency CoinMarketCap IDs. Example: 1,2
symbol string no Alternatively pass one or more comma-separated cryptocurrency symbols. Example: "BTC,ETH". At least one "id" *or* "symbol" is required.
convert string no Optionally calculate market quotes in up to 120 currencies at once by passing a comma-separated list of cryptocurrency or fiat currency symbols. Each additional convert option beyond the first requires an additional call credit. A list of supported fiat options can be found [here](/guides/standards-and-conventions). Each conversion is returned in its own "quote" object.
convert_id string no Optionally calculate market quotes by CoinMarketCap ID instead of symbol. This option is identical to `convert` outside of ID format. Ex: convert_id=1,2781 would replace convert=BTC,USD in your query. This parameter cannot be used when `convert` is used.
skip_invalid boolean no Pass `true` to relax request validation rules. When requesting records on multiple cryptocurrencies an error is returned if any invalid cryptocurrencies are requested or a cryptocurrency does not have matching records in the requested timeframe. If set to true, invalid lookups will be skipped allowing valid cryptocurrencies to still be returned.
price_performance_stats Read

Fetch the complete documentation index at: https://pro.coinmarketcap.com/llms.txt Official CoinMarketCap endpoint: GET /v2/cryptocurrency/price-performance-stats/latest.

Lua path
app.integrations.coinmarketcap.price_performance_stats
Full name
coinmarketcap.coinmarketcap_get_v2_cryptocurrency_price_performance_stats_latest
ParameterTypeRequiredDescription
id string no One or more comma-separated cryptocurrency CoinMarketCap IDs. Example: 1,2
slug string no Alternatively pass a comma-separated list of cryptocurrency slugs. Example: "bitcoin,ethereum"
symbol string no Alternatively pass one or more comma-separated cryptocurrency symbols. Example: "BTC,ETH". At least one "id" *or* "slug" *or* "symbol" is required for this request.
time_period string no Specify one or more comma-delimited time periods to return stats for. `all_time` is the default. Pass `all_time,yesterday,24h,7d,30d,90d,365d` to return all supported time periods. All rolling periods have a rolling close time of the current request time. For example `24h` would have a close time of now and an open time of 24 hours before now. *Please note: `yesterday` is a UTC period and currently does not currently support `high` and `low` timestamps.*
convert string no Optionally calculate quotes in up to 120 currencies at once by passing a comma-separated list of cryptocurrency or fiat currency symbols. Each additional convert option beyond the first requires an additional call credit. A list of supported fiat options can be found [here](/guides/standards-and-conventions). Each conversion is returned in its own "quote" object.
convert_id string no Optionally calculate quotes by CoinMarketCap ID instead of symbol. This option is identical to `convert` outside of ID format. Ex: convert_id=1,2781 would replace convert=BTC,USD in your query. This parameter cannot be used when `convert` is used.
skip_invalid boolean no Pass `true` to relax request validation rules. When requesting records on multiple cryptocurrencies an error is returned if no match is found for 1 or more requested cryptocurrencies. If set to true, invalid lookups will be skipped allowing valid cryptocurrencies to still be returned.
cryptocurrency_quotes_historical Read

Fetch the complete documentation index at: https://pro.coinmarketcap.com/llms.txt Official CoinMarketCap endpoint: GET /v3/cryptocurrency/quotes/historical.

Lua path
app.integrations.coinmarketcap.cryptocurrency_quotes_historical
Full name
coinmarketcap.coinmarketcap_get_v3_cryptocurrency_quotes_historical
ParameterTypeRequiredDescription
id string no One or more comma-separated CoinMarketCap cryptocurrency IDs. Example: "1,2"
symbol string no Alternatively pass one or more comma-separated cryptocurrency symbols. Example: "BTC,ETH". At least one "id" *or* "symbol" is required for this request.
time_start string no Timestamp (Unix or ISO 8601) to start returning quotes for. Optional, if not passed, we'll return quotes calculated in reverse from "time_end".
time_end string no Timestamp (Unix or ISO 8601) to stop returning quotes for (inclusive). Optional, if not passed, we'll default to the current time. If no "time_start" is passed, we return quotes in reverse order starting from this time.
count number no The number of interval periods to return results for. Optional, required if both "time_start" and "time_end" aren't supplied. The default is 10 items. The current query limit is 10000.
interval string no Interval of time to return data points for. See details in endpoint description.
convert string no By default market quotes are returned in USD. Optionally calculate market quotes in up to 3 other fiat currencies or cryptocurrencies.
convert_id string no Optionally calculate market quotes by CoinMarketCap ID instead of symbol. This option is identical to `convert` outside of ID format. Ex: convert_id=1,2781 would replace convert=BTC,USD in your query. This parameter cannot be used when `convert` is used.
aux string no Optionally specify a comma-separated list of supplemental data fields to return. Pass `price,volume,market_cap,circulating_supply,total_supply,quote_timestamp,is_active,is_fiat,search_interval` to include all auxiliary fields.
skip_invalid boolean no Pass `true` to relax request validation rules. When requesting records on multiple cryptocurrencies an error is returned if no match is found for 1 or more requested cryptocurrencies. If set to true, invalid lookups will be skipped allowing valid cryptocurrencies to still be returned.
cryptocurrency_quotes_latest Read

Fetch the complete documentation index at: https://pro.coinmarketcap.com/llms.txt Official CoinMarketCap endpoint: GET /v3/cryptocurrency/quotes/latest.

Lua path
app.integrations.coinmarketcap.cryptocurrency_quotes_latest
Full name
coinmarketcap.coinmarketcap_get_v3_cryptocurrency_quotes_latest
ParameterTypeRequiredDescription
id string no One or more comma-separated cryptocurrency CoinMarketCap IDs.
slug string no Alternatively pass a comma-separated list of cryptocurrency slugs.
symbol string no Alternatively pass one or more comma-separated cryptocurrency symbols.
convert string no Optionally calculate market quotes in up to 120 currencies at once by passing a comma-separated list of cryptocurrency or fiat currency symbols.
convert_id string no Optionally calculate market quotes by CoinMarketCap ID instead of symbol.
aux string no Optionally specify a comma-separated list of supplemental data fields to return.
skip_invalid string no Pass true to relax request validation rules. When requesting records on multiple cryptocurrencies an error is returned if no match is found for 1 or more requested cryptocurrencies. If set to true, invalid lookups will be skipped allowing valid cryptocurrencies to still be returned.
cryptocurrency_listings Read

Fetch the complete documentation index at: https://pro.coinmarketcap.com/llms.txt Official CoinMarketCap endpoint: GET /v3/cryptocurrency/listings/latest.

Lua path
app.integrations.coinmarketcap.cryptocurrency_listings
Full name
coinmarketcap.coinmarketcap_get_v3_cryptocurrency_listings_latest
ParameterTypeRequiredDescription
start string no Optionally offset the start (1-based index) of the paginated list of items to return.
limit string no Optionally specify the number of results to return. Use this parameter and the \"start\" parameter to determine your own pagination size.
price_min string no Optionally specify a threshold of minimum USD price to filter results by.
price_max string no Optionally specify a threshold of maximum USD price to filter results by.
market_cap_min string no Optionally specify a threshold of minimum market cap to filter results by.
market_cap_max string no Optionally specify a threshold of maximum market cap to filter results by.
volume_24h_min string no Optionally specify a threshold of minimum 24 hour USD volume to filter results by.
volume_24h_max string no Optionally specify a threshold of maximum 24 hour USD volume to filter results by.
circulating_supply_min string no Optionally specify a threshold of minimum circulating supply to filter results by.
circulating_supply_max string no Optionally specify a threshold of maximum circulating supply to filter results by.
percent_change_24h_min string no Optionally specify a threshold of minimum 24 hour percent change to filter results by.
percent_change_24h_max string no Optionally specify a threshold of maximum 24 hour percent change to filter results by.
convert string no Optionally calculate market quotes in up to 120 currencies at once by passing a comma-separated list of cryptocurrency or fiat currency symbols. Each additional convert option beyond the first requires an additional call credit. Each conversion is returned in its own "quote" object.
convert_id string no Optionally calculate market quotes by CoinMarketCap ID instead of symbol. This option is identical to `convert` outside of ID format. Ex: convert_id=1,2781 would replace convert=BTC,USD in your query. This parameter cannot be used when `convert` is used.
sort string no What field to sort the list of cryptocurrencies by.
sort_dir string no The direction in which to order cryptocurrencies against the specified sort.
cryptocurrency_type string no The type of cryptocurrency to include.
tag string no The tag of cryptocurrency to include.
aux string no Optionally specify a comma-separated list of supplemental data fields to return. Pass num_market_pairs,cmc_rank,date_added,tags,platform,max_supply,circulating_supply,total_supply,market_cap_by_total_supply,volume_24h_reported,volume_7d,volume_7d_reported,volume_30d,volume_30d_reported,is_market_cap_included_in_calc to include all auxiliary fields.
simple_price Read

Fetch the complete documentation index at: https://pro.coinmarketcap.com/llms.txt Official CoinMarketCap endpoint: GET /v1/simple/price.

Lua path
app.integrations.coinmarketcap.simple_price
Full name
coinmarketcap.coinmarketcap_get_v1_simple_price
ParameterTypeRequiredDescription
ids string yes Comma-separated list of CoinMarketCap cryptocurrency IDs. Example: "1,1027". Max query size 50.
include_market_cap boolean no Include market cap values in the response.
include_volume_24h boolean no Include 24-hour volume in the response.
include_percent_change_24h boolean no Include 24-hour price change percentage in the response.
include_last_updated boolean no Include last updated timestamp in the response.
exchange_assets Read

Fetch the complete documentation index at: https://pro.coinmarketcap.com/llms.txt Official CoinMarketCap endpoint: GET /v1/exchange/assets.

Lua path
app.integrations.coinmarketcap.exchange_assets
Full name
coinmarketcap.coinmarketcap_get_v1_exchange_assets
ParameterTypeRequiredDescription
id string no A CoinMarketCap exchange ID. Example: 270
metadata Read

Fetch the complete documentation index at: https://pro.coinmarketcap.com/llms.txt Official CoinMarketCap endpoint: GET /v1/exchange/info.

Lua path
app.integrations.coinmarketcap.metadata
Full name
coinmarketcap.coinmarketcap_get_v1_exchange_info
ParameterTypeRequiredDescription
id string no One or more comma-separated CoinMarketCap cryptocurrency exchange ids. Example: "1,2"
slug string no Alternatively, one or more comma-separated exchange names in URL friendly shorthand "slug" format (all lowercase, spaces replaced with hyphens). Example: "binance,gdax". At least one "id" *or* "slug" is required.
aux string no Optionally specify a comma-separated list of supplemental data fields to return. Pass `urls,logo,description,date_launched,notice,status` to include all auxiliary fields.
id_map Read

Fetch the complete documentation index at: https://pro.coinmarketcap.com/llms.txt Official CoinMarketCap endpoint: GET /v1/exchange/map.

Lua path
app.integrations.coinmarketcap.id_map
Full name
coinmarketcap.coinmarketcap_get_v1_exchange_map
ParameterTypeRequiredDescription
listing_status string no Only active exchanges are returned by default. Pass `inactive` to get a list of exchanges that are no longer active. Pass `untracked` to get a list of exchanges that are registered but do not currently meet methodology requirements to have active markets tracked. You may pass one or more comma-separated values.
slug string no Optionally pass a comma-separated list of exchange slugs (lowercase URL friendly shorthand name with spaces replaced with dashes) to return CoinMarketCap IDs for. If this option is passed, other options will be ignored.
start integer no Optionally offset the start (1-based index) of the paginated list of items to return.
limit integer no Optionally specify the number of results to return. Use this parameter and the "start" parameter to determine your own pagination size.
sort string no What field to sort the list of exchanges by.
aux string no Optionally specify a comma-separated list of supplemental data fields to return. Pass `first_historical_data,last_historical_data,is_active,status` to include all auxiliary fields.
crypto_id string no Optionally include one fiat or cryptocurrency IDs to filter market pairs by. For example `?crypto_id=1` would only return exchanges that have BTC.
exchange_listings_latest Read

Fetch the complete documentation index at: https://pro.coinmarketcap.com/llms.txt Official CoinMarketCap endpoint: GET /v1/exchange/listings/latest.

Lua path
app.integrations.coinmarketcap.exchange_listings_latest
Full name
coinmarketcap.coinmarketcap_get_v1_exchange_listings_latest
ParameterTypeRequiredDescription
start integer no Optionally offset the start (1-based index) of the paginated list of items to return.
limit integer no Optionally specify the number of results to return. Use this parameter and the "start" parameter to determine your own pagination size.
sort string no What field to sort the list of exchanges by.
sort_dir string no The direction in which to order exchanges against the specified sort.
market_type string no The type of exchange markets to include in rankings. This field is deprecated. Please use "all" for accurate sorting.
category string no The category for this exchange.
aux string no Optionally specify a comma-separated list of supplemental data fields to return. Pass `num_market_pairs,traffic_score,rank,exchange_score,effective_liquidity_24h,date_launched,fiats` to include all auxiliary fields.
convert string no Optionally calculate market quotes in up to 120 currencies at once by passing a comma-separated list of cryptocurrency or fiat currency symbols. Each additional convert option beyond the first requires an additional call credit. A list of supported fiat options can be found [here](/guides/standards-and-conventions). Each conversion is returned in its own "quote" object.
convert_id string no Optionally calculate market quotes by CoinMarketCap ID instead of symbol. This option is identical to `convert` outside of ID format. Ex: convert_id=1,2781 would replace convert=BTC,USD in your query. This parameter cannot be used when `convert` is used.
pairs_latest Read

Fetch the complete documentation index at: https://pro.coinmarketcap.com/llms.txt Official CoinMarketCap endpoint: GET /v1/exchange/market-pairs/latest.

Lua path
app.integrations.coinmarketcap.pairs_latest
Full name
coinmarketcap.coinmarketcap_get_v1_exchange_market_pairs_latest
ParameterTypeRequiredDescription
id string no A CoinMarketCap exchange ID. Example: "1"
slug string no Alternatively pass an exchange "slug" (URL friendly all lowercase shorthand version of name with spaces replaced with hyphens). Example: "binance". One "id" *or* "slug" is required.
start integer no Optionally offset the start (1-based index) of the paginated list of items to return.
limit integer no Optionally specify the number of results to return. Use this parameter and the "start" parameter to determine your own pagination size.
aux string no Optionally specify a comma-separated list of supplemental data fields to return. Pass `num_market_pairs,category,fee_type,market_url,currency_name,currency_slug,price_quote,effective_liquidity,market_score,market_reputation` to include all auxiliary fields.
matched_id string no Optionally include one or more comma-delimited fiat or cryptocurrency IDs to filter market pairs by. For example `?matched_id=2781` would only return BTC markets that matched: "BTC/USD" or "USD/BTC" for the requested exchange. This parameter cannot be used when `matched_symbol` is used.
matched_symbol string no Optionally include one or more comma-delimited fiat or cryptocurrency symbols to filter market pairs by. For example `?matched_symbol=USD` would only return BTC markets that matched: "BTC/USD" or "USD/BTC" for the requested exchange. This parameter cannot be used when `matched_id` is used.
category string no The category of trading this market falls under. Spot markets are the most common but options include derivatives and OTC.
fee_type string no The fee type the exchange enforces for this market.
convert string no Optionally calculate market quotes in up to 120 currencies at once by passing a comma-separated list of cryptocurrency or fiat currency symbols. Each additional convert option beyond the first requires an additional call credit. A list of supported fiat options can be found [here](/guides/standards-and-conventions). Each conversion is returned in its own "quote" object.
convert_id string no Optionally calculate market quotes by CoinMarketCap ID instead of symbol. This option is identical to `convert` outside of ID format. Ex: convert_id=1,2781 would replace convert=BTC,USD in your query. This parameter cannot be used when `convert` is used.
quotes_historical Read

Fetch the complete documentation index at: https://pro.coinmarketcap.com/llms.txt Official CoinMarketCap endpoint: GET /v1/exchange/quotes/historical.

Lua path
app.integrations.coinmarketcap.quotes_historical
Full name
coinmarketcap.coinmarketcap_get_v1_exchange_quotes_historical
ParameterTypeRequiredDescription
id string no One or more comma-separated exchange CoinMarketCap ids. Example: "24,270"
slug string no Alternatively, one or more comma-separated exchange names in URL friendly shorthand "slug" format (all lowercase, spaces replaced with hyphens). Example: "binance,kraken". At least one "id" *or* "slug" is required.
time_start string no Timestamp (Unix or ISO 8601) to start returning quotes for. Optional, if not passed, we'll return quotes calculated in reverse from "time_end".
time_end string no Timestamp (Unix or ISO 8601) to stop returning quotes for (inclusive). Optional, if not passed, we'll default to the current time. If no "time_start" is passed, we return quotes in reverse order starting from this time.
count number no The number of interval periods to return results for. Optional, required if both "time_start" and "time_end" aren't supplied. The default is 10 items. The current query limit is 10000.
interval string no Interval of time to return data points for. See details in endpoint description.
convert string no By default market quotes are returned in USD. Optionally calculate market quotes in up to 3 other fiat currencies or cryptocurrencies.
convert_id string no Optionally calculate market quotes by CoinMarketCap ID instead of symbol. This option is identical to `convert` outside of ID format. Ex: convert_id=1,2781 would replace convert=BTC,USD in your query. This parameter cannot be used when `convert` is used.
quotes_latest Read

Fetch the complete documentation index at: https://pro.coinmarketcap.com/llms.txt Official CoinMarketCap endpoint: GET /v1/exchange/quotes/latest.

Lua path
app.integrations.coinmarketcap.quotes_latest
Full name
coinmarketcap.coinmarketcap_get_v1_exchange_quotes_latest
ParameterTypeRequiredDescription
id string no One or more comma-separated CoinMarketCap exchange IDs. Example: "1,2"
slug string no Alternatively, pass a comma-separated list of exchange "slugs" (URL friendly all lowercase shorthand version of name with spaces replaced with hyphens). Example: "binance,gdax". At least one "id" *or* "slug" is required.
convert string no Optionally calculate market quotes in up to 120 currencies at once by passing a comma-separated list of cryptocurrency or fiat currency symbols. Each additional convert option beyond the first requires an additional call credit. A list of supported fiat options can be found [here](/guides/standards-and-conventions). Each conversion is returned in its own "quote" object.
convert_id string no Optionally calculate market quotes by CoinMarketCap ID instead of symbol. This option is identical to `convert` outside of ID format. Ex: convert_id=1,2781 would replace convert=BTC,USD in your query. This parameter cannot be used when `convert` is used.
aux string no Optionally specify a comma-separated list of supplemental data fields to return. Pass `num_market_pairs,traffic_score,rank,exchange_score,liquidity_score,effective_liquidity_24h` to include all auxiliary fields.
cmc_crypto_fear_and_greed_historical Read

Fetch the complete documentation index at: https://pro.coinmarketcap.com/llms.txt Official CoinMarketCap endpoint: GET /v3/fear-and-greed/historical.

Lua path
app.integrations.coinmarketcap.cmc_crypto_fear_and_greed_historical
Full name
coinmarketcap.coinmarketcap_get_v3_fear_and_greed_historical
ParameterTypeRequiredDescription
start integer no Optionally offset the start (1-based index) of the paginated list of items to return.
limit integer no Optionally specify the number of results to return. Use this parameter and the "start" parameter to determine your own pagination size.
cmc_crypto_fear_and_greed_latest Read

Fetch the complete documentation index at: https://pro.coinmarketcap.com/llms.txt Official CoinMarketCap endpoint: GET /v3/fear-and-greed/latest.

Lua path
app.integrations.coinmarketcap.cmc_crypto_fear_and_greed_latest
Full name
coinmarketcap.coinmarketcap_get_v3_fear_and_greed_latest
ParameterTypeRequiredDescription
No parameters.
quotes_historical Read

Fetch the complete documentation index at: https://pro.coinmarketcap.com/llms.txt Official CoinMarketCap endpoint: GET /v1/global-metrics/quotes/historical.

Lua path
app.integrations.coinmarketcap.quotes_historical
Full name
coinmarketcap.coinmarketcap_get_v1_global_metrics_quotes_historical
ParameterTypeRequiredDescription
time_start string no Timestamp (Unix or ISO 8601) to start returning quotes for. Optional, if not passed, we'll return quotes calculated in reverse from "time_end".
time_end string no Timestamp (Unix or ISO 8601) to stop returning quotes for (inclusive). Optional, if not passed, we'll default to the current time. If no "time_start" is passed, we return quotes in reverse order starting from this time.
count number no The number of interval periods to return results for. Optional, required if both "time_start" and "time_end" aren't supplied. The default is 10 items. The current query limit is 10000.
interval string no Interval of time to return data points for. See details in endpoint description.
convert string no By default market quotes are returned in USD. Optionally calculate market quotes in up to 3 other fiat currencies or cryptocurrencies.
convert_id string no Optionally calculate market quotes by CoinMarketCap ID instead of symbol. This option is identical to `convert` outside of ID format. Ex: convert_id=1,2781 would replace convert=BTC,USD in your query. This parameter cannot be used when `convert` is used.
aux string no Optionally specify a comma-separated list of supplemental data fields to return. Pass `btc_dominance,eth_dominance,active_cryptocurrencies,active_exchanges,active_market_pairs,total_volume_24h,total_volume_24h_reported,altcoin_market_cap,altcoin_volume_24h,altcoin_volume_24h_reported,search_interval` to include all auxiliary fields.
quotes_latest Read

Fetch the complete documentation index at: https://pro.coinmarketcap.com/llms.txt Official CoinMarketCap endpoint: GET /v1/global-metrics/quotes/latest.

Lua path
app.integrations.coinmarketcap.quotes_latest
Full name
coinmarketcap.coinmarketcap_get_v1_global_metrics_quotes_latest
ParameterTypeRequiredDescription
convert string no Optionally calculate market quotes in up to 120 currencies at once by passing a comma-separated list of cryptocurrency or fiat currency symbols. Each additional convert option beyond the first requires an additional call credit. A list of supported fiat options can be found [here](/guides/standards-and-conventions). Each conversion is returned in its own "quote" object.
convert_id string no Optionally calculate market quotes by CoinMarketCap ID instead of symbol. This option is identical to `convert` outside of ID format. Ex: convert_id=1,2781 would replace convert=BTC,USD in your query. This parameter cannot be used when `convert` is used.
altcoin_season_index_latest Read

Fetch the complete documentation index at: https://pro.coinmarketcap.com/llms.txt Official CoinMarketCap endpoint: GET /v1/altcoin-season-index/latest.

Lua path
app.integrations.coinmarketcap.altcoin_season_index_latest
Full name
coinmarketcap.coinmarketcap_get_v1_altcoin_season_index_latest
ParameterTypeRequiredDescription
No parameters.
altcoin_season_index_historical Read

Fetch the complete documentation index at: https://pro.coinmarketcap.com/llms.txt Official CoinMarketCap endpoint: GET /v1/altcoin-season-index/historical.

Lua path
app.integrations.coinmarketcap.altcoin_season_index_historical
Full name
coinmarketcap.coinmarketcap_get_v1_altcoin_season_index_historical
ParameterTypeRequiredDescription
timeframe string no Timeframe for historical data. Valid values are 7d, 30d, and 90d. Default is 7d.
content_latest Read

Fetch the complete documentation index at: https://pro.coinmarketcap.com/llms.txt Official CoinMarketCap endpoint: GET /v1/content/latest.

Lua path
app.integrations.coinmarketcap.content_latest
Full name
coinmarketcap.coinmarketcap_get_v1_content_latest
ParameterTypeRequiredDescription
start integer no Optionally offset the start (1-based index) of the paginated list of items to return.
limit integer no Optionally specify the number of results to return. Use this parameter and the "start" parameter to determine your own pagination size.
id string no Optionally pass a comma-separated list of CoinMarketCap cryptocurrency IDs. Example: "1,1027"
slug string no Optionally pass a comma-separated list of cryptocurrency slugs. Example: "bitcoin,ethereum"
symbol string no Optionally pass a comma-separated list of cryptocurrency symbols. Example: "BTC,ETH". Optionally pass "id" *or* "slug" *or* "symbol" is required for this request.
news_type string no Optionally specify a comma-separated list of supplemental data fields: `news`, `community`, or `alexandria` to filter news sources. Pass `all` or leave it blank to include all news types.
content_type string no Optionally specify a comma-separated list of supplemental data fields: `news`, `video`, or `audio` to filter news's content. Pass `all` or leave it blank to include all content types.
category string no Optionally pass a comma-separated list of categories. Example: "GameFi,NFT".
language string no Optionally pass a language code. Example: "en". If not specified the default value is "en".
content_post_comments Read

Fetch the complete documentation index at: https://pro.coinmarketcap.com/llms.txt Official CoinMarketCap endpoint: GET /v1/content/posts/comments.

Lua path
app.integrations.coinmarketcap.content_post_comments
Full name
coinmarketcap.coinmarketcap_get_v1_content_posts_comments
ParameterTypeRequiredDescription
post_id string yes Required post ID. Example: 325670123
content_latest_posts Read

Fetch the complete documentation index at: https://pro.coinmarketcap.com/llms.txt Official CoinMarketCap endpoint: GET /v1/content/posts/latest.

Lua path
app.integrations.coinmarketcap.content_latest_posts
Full name
coinmarketcap.coinmarketcap_get_v1_content_posts_latest
ParameterTypeRequiredDescription
id string no Optional one cryptocurrency CoinMarketCap ID. Example: 1027
slug string no Alternatively pass one cryptocurrency slug. Example: "ethereum"
symbol string no Alternatively pass one cryptocurrency symbols. Example: "ETH"
last_score string no Optional. The score is given in the response for finding next batch posts. Example: 1662903634322
content_top_posts Read

Fetch the complete documentation index at: https://pro.coinmarketcap.com/llms.txt Official CoinMarketCap endpoint: GET /v1/content/posts/top.

Lua path
app.integrations.coinmarketcap.content_top_posts
Full name
coinmarketcap.coinmarketcap_get_v1_content_posts_top
ParameterTypeRequiredDescription
id string no Optional one cryptocurrency CoinMarketCap ID. Example: 1027
slug string no Alternatively pass one cryptocurrency slug. Example: "ethereum"
symbol string no Alternatively pass one cryptocurrency symbols. Example: "ETH"
last_score string no Optional. The score is given in the response for finding next batch of related posts. Example: 38507.8865
100_index_historical Read

Fetch the complete documentation index at: https://pro.coinmarketcap.com/llms.txt Official CoinMarketCap endpoint: GET /v3/index/cmc100-historical.

Lua path
app.integrations.coinmarketcap.100_index_historical
Full name
coinmarketcap.coinmarketcap_get_v3_index_cmc100_historical
ParameterTypeRequiredDescription
time_start string no Timestamp (Unix or ISO 8601) to start returning CoinMarketCap 100 Index data for. Optional, if not passed, we'll return quotes calculated in reverse from "time_end".
time_end string no Timestamp (Unix or ISO 8601) to stop returning CoinMarketCap 100 Index data for (inclusive). Optional, if not passed, we'll default to the current time. If no "time_start" is passed, we return quotes in reverse order starting from this time.
count string no The number of interval periods to return results for. Optional, required if both "time_start" and "time_end" aren't supplied. The default is 5 items. If "time_start" and "time_end" are supplied, the query limit is 10 and the count starts from "time_start".
interval string no Optionally adjust the interval of data returned.Valid values:"5m","15m","daily".
100_index_latest Read

Fetch the complete documentation index at: https://pro.coinmarketcap.com/llms.txt Official CoinMarketCap endpoint: GET /v3/index/cmc100-latest.

Lua path
app.integrations.coinmarketcap.100_index_latest
Full name
coinmarketcap.coinmarketcap_get_v3_index_cmc100_latest
ParameterTypeRequiredDescription
No parameters.
20_index_historical Read

Fetch the complete documentation index at: https://pro.coinmarketcap.com/llms.txt Official CoinMarketCap endpoint: GET /v3/index/cmc20-historical.

Lua path
app.integrations.coinmarketcap.20_index_historical
Full name
coinmarketcap.coinmarketcap_get_v3_index_cmc20_historical
ParameterTypeRequiredDescription
time_start string no Timestamp (Unix or ISO 8601) to start returning CoinMarketCap 20 Index data for. Optional, if not passed, we'll return quotes calculated in reverse from "time_end".
time_end string no Timestamp (Unix or ISO 8601) to stop returning CoinMarketCap 20 Index data for (inclusive). Optional, if not passed, we'll default to the current time. If no "time_start" is passed, we return quotes in reverse order starting from this time.
count string no The number of interval periods to return results for. Optional, required if both "time_start" and "time_end" aren't supplied. The default is 5 items. If "time_start" and "time_end" are supplied, the query limit is 10 and the count starts from "time_start".
interval string no Optionally adjust the interval of data returned.Valid values:"5m","15m","daily".
20_index_latest Read

Fetch the complete documentation index at: https://pro.coinmarketcap.com/llms.txt Official CoinMarketCap endpoint: GET /v3/index/cmc20-latest.

Lua path
app.integrations.coinmarketcap.20_index_latest
Full name
coinmarketcap.coinmarketcap_get_v3_index_cmc20_latest
ParameterTypeRequiredDescription
No parameters.
batch_query_tokens Read

Fetch the complete documentation index at: https://pro.coinmarketcap.com/llms.txt Official CoinMarketCap endpoint: POST /v1/dex/tokens/batch-query.

Lua path
app.integrations.coinmarketcap.batch_query_tokens
Full name
coinmarketcap.coinmarketcap_post_v1_dex_tokens_batch_query
ParameterTypeRequiredDescription
body object yes JSON request body matching the CoinMarketCap API schema for this endpoint.
batch_get_token_prices Read

Fetch the complete documentation index at: https://pro.coinmarketcap.com/llms.txt Official CoinMarketCap endpoint: POST /v1/dex/token/price/batch.

Lua path
app.integrations.coinmarketcap.batch_get_token_prices
Full name
coinmarketcap.coinmarketcap_post_v1_dex_token_price_batch
ParameterTypeRequiredDescription
body object yes JSON request body matching the CoinMarketCap API schema for this endpoint.
get_new_tokens Read

Fetch the complete documentation index at: https://pro.coinmarketcap.com/llms.txt Official CoinMarketCap endpoint: POST /v1/dex/new/list.

Lua path
app.integrations.coinmarketcap.get_new_tokens
Full name
coinmarketcap.coinmarketcap_post_v1_dex_new_list
ParameterTypeRequiredDescription
body object yes JSON request body matching the CoinMarketCap API schema for this endpoint.
get_meme_tokens Read

Fetch the complete documentation index at: https://pro.coinmarketcap.com/llms.txt Official CoinMarketCap endpoint: POST /v1/dex/meme/list.

Lua path
app.integrations.coinmarketcap.get_meme_tokens
Full name
coinmarketcap.coinmarketcap_post_v1_dex_meme_list
ParameterTypeRequiredDescription
body object yes JSON request body matching the CoinMarketCap API schema for this endpoint.
get_top_gainers_and_losers Read

Fetch the complete documentation index at: https://pro.coinmarketcap.com/llms.txt Official CoinMarketCap endpoint: POST /v1/dex/gainer-loser/list.

Lua path
app.integrations.coinmarketcap.get_top_gainers_and_losers
Full name
coinmarketcap.coinmarketcap_post_v1_dex_gainer_loser_list
ParameterTypeRequiredDescription
body object yes JSON request body matching the CoinMarketCap API schema for this endpoint.
pairs_listings_latest Read

Fetch the complete documentation index at: https://pro.coinmarketcap.com/llms.txt Official CoinMarketCap endpoint: GET /v4/dex/spot-pairs/latest.

Lua path
app.integrations.coinmarketcap.pairs_listings_latest
Full name
coinmarketcap.coinmarketcap_get_v4_dex_spot_pairs_latest
ParameterTypeRequiredDescription
network_id string no One or more comma-separated CoinMarketCap cryptocurrency network ids.
network_slug string no Alternatively, one or more comma-separated network names in URL friendly shorthand slug format (all lowercase, spaces replaced with hyphens). At least one id or slug is required.
dex_id string no One or more comma-separated CoinMarketCap dex exchange ids
dex_slug string no Alternatively, one or more comma-separated dex exchange names in URL friendly shorthand slug format (all lowercase, spaces replaced with hyphens). At least one id or slug is required.
base_asset_id string no One or more comma-separated CoinMarketCap cryptocurrency ids.
base_asset_symbol string no Alternatively, one or more comma-separated network symbol in URL friendly shorthand slug format (all lowercase, spaces replaced with hyphens).At least one id or slug is required.
base_asset_contract_address string no Alternatively, one base asset contract address in URL friendly shorthand slug format (all lowercase, spaces replaced with hyphens).At least one id or slug is required.
base_asset_ucid string no One or more comma-separated CoinMarketCap cryptocurrency IDs.
quote_asset_id string no One or more comma-separated CoinMarketCap cryptocurrency ids.
quote_asset_symbol string no Alternatively, one or more comma-separated network symbol in URL friendly shorthand slug format (all lowercase, spaces replaced with hyphens). At least one id or slug is required.
quote_asset_contract_address string no Alternatively, one quote asset contract address in URL friendly shorthand slug format (all lowercase, spaces replaced with hyphens). At least one id or slug is required.
quote_asset_ucid string no One or more comma-separated CoinMarketCap cryptocurrency IDs.
scroll_id string no After your initial query, the API responds with the initial set of results and a scroll_ids. To retrieve the next set of results, provide this scroll_id of the last JSON with your follow-up request. scroll_id is an alternative to traditional pagination techniques.
limit string no Optionally specify the number of results to return. Use this parameter and the start parameter to determine your own pagination size.
liquidity_min string no Optionally specify a threshold of minimum liquidity to filter results by.
liquidity_max string no Optionally specify a threshold of maximum liquidity to filter results by.
volume_24h_min string no Optionally specify a threshold of minimum 24 hour USD volume to filter results by.
volume_24h_max string no Optionally specify a threshold of maximum 24 hour USD volume to filter results by.
no_of_transactions_24h_min string no Optionally specify a threshold of minimum 24h no. of transactions to filter results by.
no_of_transactions_24h_max string no Optionally specify a threshold of maximum 24h no. of transactions to filter results by.
percent_change_24h_min string no Optionally specify a threshold of minimum 24 hour percent change to filter results by.
percent_change_24h_max string no Optionally specify a threshold of maximum 24 hour percent change to filter results by.
sort string no Default:`"volume_24h"` Valid values: `"volume_24h"` `"liquidity"` `"no_of_transactions_24h"` `"percent_change_24h"` // todo Sort the list of dex spot pairs by.
sort_dir string no Default:`"desc"` Valid values: `"desc"` `"asc"` The direction in which to order dex spot pairs against the specified sort.
aux string no Default:`""` Valid values: `"pool_created"` `"percent_pooled_base_asset"` `"num_transactions_24h"` `"pool_base_asset"` `"pool_quote_asset"` `"24h_volume_quote_asset"` `"total_supply_quote_asset"` `"total_supply_base_asset"` `"holders"` `"buy_tax"` `"sell_tax"` `"security_scan"` `"24h_no_of_buys"` `"24h_no_of_sells"` `"24h_buy_volume"` `"24h_sell_volume"` Optionally specify a comma-separated list of supplemental data fields to return.
reverse_order string no Pass true to invert the order of a spot pair. For example, a trading pair is set up as Token B/Token A in the contract and is commonly referred to as Token A/Token B. Using reverse_order would change the order to reflect the true Token B/Token A pairing as it exists in the pool.
convert_id string no Optionally calculate market quotes by CoinMarketCap ID instead of symbol. This option is identical to convert outside of ID format. Ex: convert_id=1,2781 would replace convert=BTC,USD in your query. This parameter cannot be used when convert is used.
quotes_latest Read

Fetch the complete documentation index at: https://pro.coinmarketcap.com/llms.txt Official CoinMarketCap endpoint: GET /v4/dex/pairs/quotes/latest.

Lua path
app.integrations.coinmarketcap.quotes_latest
Full name
coinmarketcap.coinmarketcap_get_v4_dex_pairs_quotes_latest
ParameterTypeRequiredDescription
contract_address string no One or more comma-separated contract addresses.
network_id string no One or more CoinMarketCap cryptocurrency network ids
network_slug string no Alternatively, one network names in URL friendly shorthand "slug" format (all lowercase, spaces replaced with hyphens).
aux string no Default:`""` Valid values: `"pool_created"` `"percent_pooled_base_asset"` `"num_transactions_24h"` `"pool_base_asset"` `"pool_quote_asset"` `"24h_volume_quote_asset"` `"total_supply_quote_asset"` `"total_supply_base_asset"` `"holders"` `"buy_tax"` `"sell_tax"` `"security_scan"` `"24h_no_of_buys"` `"24h_no_of_sells"` `"24h_buy_volume"` `"24h_sell_volume"` Optionally specify a comma-separated list of supplemental data fields to return.
convert_id string no Optionally calculate market quotes by CoinMarketCap ID instead of symbol. This option is identical to convert outside of ID format. Ex: convert_id=1,2781 would replace convert=BTC,USD in your query. This parameter cannot be used when convert is used.
skip_invalid string no Pass true to relax request validation rules. When requesting records on multiple spot pairs an error is returned if no match is found for 1 or more requested spot pairs. If set to true, invalid lookups will be skipped allowing valid spot pairs to still be returned.
reverse_order string no Pass true to invert the order of a spot pair. For example, a trading pair is set up as Token B/Token A in the contract and is commonly referred to as Token A/Token B. Using reverse_order would change the order to reflect the true Token B/Token A pairing as it exists in the pool.
get_token_detail Read

Fetch the complete documentation index at: https://pro.coinmarketcap.com/llms.txt Official CoinMarketCap endpoint: GET /v1/dex/token.

Lua path
app.integrations.coinmarketcap.get_token_detail
Full name
coinmarketcap.coinmarketcap_get_v1_dex_token
ParameterTypeRequiredDescription
platform string no Platform name
address string no Token address
get_token_price Read

Fetch the complete documentation index at: https://pro.coinmarketcap.com/llms.txt Official CoinMarketCap endpoint: GET /v1/dex/token/price.

Lua path
app.integrations.coinmarketcap.get_token_price
Full name
coinmarketcap.coinmarketcap_get_v1_dex_token_price
ParameterTypeRequiredDescription
platform string no Platform name
address string no Token address
get_token_pools Read

Fetch the complete documentation index at: https://pro.coinmarketcap.com/llms.txt Official CoinMarketCap endpoint: GET /v1/dex/token/pools.

Lua path
app.integrations.coinmarketcap.get_token_pools
Full name
coinmarketcap.coinmarketcap_get_v1_dex_token_pools
ParameterTypeRequiredDescription
platform string no Platform name
address string no Token address
size integer no Query parameter `size`.
query_token_liquidity Read

Fetch the complete documentation index at: https://pro.coinmarketcap.com/llms.txt Official CoinMarketCap endpoint: GET /v1/dex/token-liquidity/query.

Lua path
app.integrations.coinmarketcap.query_token_liquidity
Full name
coinmarketcap.coinmarketcap_get_v1_dex_token_liquidity_query
ParameterTypeRequiredDescription
platform string no Platform name
address string no Token address
interval string no Time interval
limit integer no Result limit
to integer no End timestamp
needlatest boolean no Whether to include latest value
get_swap_list Read

Fetch the complete documentation index at: https://pro.coinmarketcap.com/llms.txt Official CoinMarketCap endpoint: GET /v1/dex/tokens/transactions.

Lua path
app.integrations.coinmarketcap.get_swap_list
Full name
coinmarketcap.coinmarketcap_get_v1_dex_tokens_transactions
ParameterTypeRequiredDescription
platform string no Blockchain platform name (bsc/sol/etc)
address string no Token contract address
type integer no Transaction type (0 for buy, 1 for sell)
types array no Transaction types filter, supports: buy, sell, open, close, add, reduce
maker string no Maker address, support comma separated list
sortby string no Field to sort by (currently only supports 'time')
sorttype string no Sort direction ('asc' or 'desc', default is 'desc')
starttime integer no Start timestamp (inclusive)
endtime integer no End timestamp (inclusive)
minvolume number no Minimum volume (inclusive)
maxvolume number no Maximum volume (inclusive)
lastid string no Cursor for pagination, format: ts_txHash_logId
limit integer no Result limit
version string no Version
get_security_detail Read

Fetch the complete documentation index at: https://pro.coinmarketcap.com/llms.txt Official CoinMarketCap endpoint: GET /v1/dex/security/detail.

Lua path
app.integrations.coinmarketcap.get_security_detail
Full name
coinmarketcap.coinmarketcap_get_v1_dex_security_detail
ParameterTypeRequiredDescription
platformname string no Platform name
address string no Token address
search_tokens Read

Fetch the complete documentation index at: https://pro.coinmarketcap.com/llms.txt Official CoinMarketCap endpoint: GET /v1/dex/search.

Lua path
app.integrations.coinmarketcap.search_tokens
Full name
coinmarketcap.coinmarketcap_get_v1_dex_search
ParameterTypeRequiredDescription
q string no Search keyword
platform string no Platform filter
sort string no Sort field
limit integer no Result limit
code string no Code filter
get_liquidity_change_list Write

Fetch the complete documentation index at: https://pro.coinmarketcap.com/llms.txt Official CoinMarketCap endpoint: GET /v1/dex/liquidity-change/list.

Lua path
app.integrations.coinmarketcap.get_liquidity_change_list
Full name
coinmarketcap.coinmarketcap_get_v1_dex_liquidity_change_list
ParameterTypeRequiredDescription
platform string no Blockchain platform name (bsc/sol/etc)
address string no Token contract address
type integer no Liquidity change type
maker string no Maker address, support comma separated list
sortby string no Field to sort by (currently only supports 'ts')
sorttype string no Sort direction ('asc' or 'desc', default is 'desc')
starttime integer no Start timestamp (inclusive)
endtime integer no End timestamp (inclusive)
minvolume number no Minimum USD volume (inclusive)
maxvolume number no Maximum USD volume (inclusive)
lastid string no Cursor for pagination, format: ts_txHash_logId
limit integer no Result limit
get_platform_list Read

Fetch the complete documentation index at: https://pro.coinmarketcap.com/llms.txt Official CoinMarketCap endpoint: GET /v1/dex/platform/list.

Lua path
app.integrations.coinmarketcap.get_platform_list
Full name
coinmarketcap.coinmarketcap_get_v1_dex_platform_list
ParameterTypeRequiredDescription
No parameters.
get_platform_detail Read

Fetch the complete documentation index at: https://pro.coinmarketcap.com/llms.txt Official CoinMarketCap endpoint: GET /v1/dex/platform/detail.

Lua path
app.integrations.coinmarketcap.get_platform_detail
Full name
coinmarketcap.coinmarketcap_get_v1_dex_platform_detail
ParameterTypeRequiredDescription
platformname string no Platform name
get_holders_list Read

Fetch the complete documentation index at: https://pro.coinmarketcap.com/llms.txt Official CoinMarketCap endpoint: POST /v1/dex/holders/list.

Lua path
app.integrations.coinmarketcap.get_holders_list
Full name
coinmarketcap.coinmarketcap_post_v1_dex_holders_list
ParameterTypeRequiredDescription
body object yes JSON request body matching the CoinMarketCap API schema for this endpoint.
get_holder_detail Read

Fetch the complete documentation index at: https://pro.coinmarketcap.com/llms.txt Official CoinMarketCap endpoint: POST /v1/dex/holders/detail.

Lua path
app.integrations.coinmarketcap.get_holder_detail
Full name
coinmarketcap.coinmarketcap_post_v1_dex_holders_detail
ParameterTypeRequiredDescription
body object yes JSON request body matching the CoinMarketCap API schema for this endpoint.
get_holder_trend_list Read

Fetch the complete documentation index at: https://pro.coinmarketcap.com/llms.txt Official CoinMarketCap endpoint: GET /v1/dex/holders/trend/list.

Lua path
app.integrations.coinmarketcap.get_holder_trend_list
Full name
coinmarketcap.coinmarketcap_get_v1_dex_holders_trend_list
ParameterTypeRequiredDescription
platform string no Platform name or id
tokenaddress string no Token address
interval string no Kline interval: 1d
from integer no start timestamp
to integer no End timestamp
limit integer no Number of to load
get_holder_tag_count Read

Fetch the complete documentation index at: https://pro.coinmarketcap.com/llms.txt Official CoinMarketCap endpoint: GET /v1/dex/holders/tag_count.

Lua path
app.integrations.coinmarketcap.get_holder_tag_count
Full name
coinmarketcap.coinmarketcap_get_v1_dex_holders_tag_count
ParameterTypeRequiredDescription
platform string yes Query parameter `platform`.
tokenaddress string yes Query parameter `tokenAddress`.
get_holder_count Read

Fetch the complete documentation index at: https://pro.coinmarketcap.com/llms.txt Official CoinMarketCap endpoint: GET /v1/dex/holders/count.

Lua path
app.integrations.coinmarketcap.get_holder_count
Full name
coinmarketcap.coinmarketcap_get_v1_dex_holders_count
ParameterTypeRequiredDescription
platform string yes Query parameter `platform`.
tokenaddress string yes Query parameter `tokenAddress`.
get_line_points Read

Fetch the complete documentation index at: https://pro.coinmarketcap.com/llms.txt Official CoinMarketCap endpoint: GET /v1/k-line/points.

Lua path
app.integrations.coinmarketcap.get_line_points
Full name
coinmarketcap.coinmarketcap_get_v1_k_line_points
ParameterTypeRequiredDescription
platform string no Platform name or id
address string no Token or pool address
interval string no Kline interval: 1s/5s/30s/1min/3min/5min/15min/30min/1h/2h/4h/6h/8h/12h/1d/3d/1w/1m
from integer no Start timestamp (UNIX epoch)
to integer no End timestamp (UNIX epoch)
unit string no Kline unit: usd, native, quote
limit integer no Number of points to load
pm string no Kline type: p (price), m (marketcap)
get_line_candles Read

Fetch the complete documentation index at: https://pro.coinmarketcap.com/llms.txt Official CoinMarketCap endpoint: GET /v1/k-line/candles.

Lua path
app.integrations.coinmarketcap.get_line_candles
Full name
coinmarketcap.coinmarketcap_get_v1_k_line_candles
ParameterTypeRequiredDescription
platform string no Platform name or id
address string no Token or pool address
interval string no Kline interval: 1s/5s/30s/1min/3min/5min/15min/30min/1h/2h/4h/6h/8h/12h/1d/3d/1w/1m
from integer no Start timestamp (UNIX epoch)
to integer no End timestamp (UNIX epoch)
unit string no Kline unit: usd, native, quote
limit integer no Number of candles to load
pm string no Kline type: p (price), m (marketcap)
fiat_id_map Read

Fetch the complete documentation index at: https://pro.coinmarketcap.com/llms.txt Official CoinMarketCap endpoint: GET /v1/fiat/map.

Lua path
app.integrations.coinmarketcap.fiat_id_map
Full name
coinmarketcap.coinmarketcap_get_v1_fiat_map
ParameterTypeRequiredDescription
start integer no Optionally offset the start (1-based index) of the paginated list of items to return.
limit integer no Optionally specify the number of results to return. Use this parameter and the "start" parameter to determine your own pagination size.
sort string no What field to sort the list by.
include_metals boolean no Pass `true` to include precious metals.
key_info Read

Fetch the complete documentation index at: https://pro.coinmarketcap.com/llms.txt Official CoinMarketCap endpoint: GET /v1/key/info.

Lua path
app.integrations.coinmarketcap.key_info
Full name
coinmarketcap.coinmarketcap_get_v1_key_info
ParameterTypeRequiredDescription
No parameters.
postman_conversion_v1 Read

Fetch the complete documentation index at: https://pro.coinmarketcap.com/llms.txt Official CoinMarketCap endpoint: GET /v1/tools/postman.

Lua path
app.integrations.coinmarketcap.postman_conversion_v1
Full name
coinmarketcap.coinmarketcap_get_v1_tools_postman
ParameterTypeRequiredDescription
No parameters.
price_conversion_v2 Read

Fetch the complete documentation index at: https://pro.coinmarketcap.com/llms.txt Official CoinMarketCap endpoint: GET /v2/tools/price-conversion.

Lua path
app.integrations.coinmarketcap.price_conversion_v2
Full name
coinmarketcap.coinmarketcap_get_v2_tools_price_conversion
ParameterTypeRequiredDescription
amount number yes An amount of currency to convert. Example: 10.43
id string no The CoinMarketCap currency ID of the base cryptocurrency or fiat to convert from. Example: "1"
symbol string no Alternatively the currency symbol of the base cryptocurrency or fiat to convert from. Example: "BTC". One "id" *or* "symbol" is required. Please note that starting in the v2 endpoint, due to the fact that a symbol is not unique, if you request by symbol each quote response will contain an array of objects containing all of the coins that use each requested symbol. The v1 endpoint will still return a single object, the highest ranked coin using that symbol.
time string no Optional timestamp (Unix or ISO 8601) to reference historical pricing during conversion. If not passed, the current time will be used. If passed, we'll reference the closest historic values available for this conversion.
convert string no Pass up to 120 comma-separated fiat or cryptocurrency symbols to convert the source amount to.
convert_id string no Optionally calculate market quotes by CoinMarketCap ID instead of symbol. This option is identical to `convert` outside of ID format. Ex: convert_id=1,2781 would replace convert=BTC,USD in your query. This parameter cannot be used when `convert` is used.
statistics_latest Read

Fetch the complete documentation index at: https://pro.coinmarketcap.com/llms.txt Official CoinMarketCap endpoint: GET /v1/blockchain/statistics/latest.

Lua path
app.integrations.coinmarketcap.statistics_latest
Full name
coinmarketcap.coinmarketcap_get_v1_blockchain_statistics_latest
ParameterTypeRequiredDescription
id string no One or more comma-separated cryptocurrency CoinMarketCap IDs to return blockchain data for. Pass `1,2,1027` to request all currently supported blockchains.
symbol string no Alternatively pass one or more comma-separated cryptocurrency symbols. Pass `BTC,LTC,ETH` to request all currently supported blockchains.
slug string no Alternatively pass a comma-separated list of cryptocurrency slugs. Pass `bitcoin,litecoin,ethereum` to request all currently supported blockchains.
metadata_v1_deprecated Read

Fetch the complete documentation index at: https://pro.coinmarketcap.com/llms.txt Official CoinMarketCap endpoint: GET /v1/cryptocurrency/info.

Lua path
app.integrations.coinmarketcap.metadata_v1_deprecated
Full name
coinmarketcap.coinmarketcap_get_v1_cryptocurrency_info
ParameterTypeRequiredDescription
id string no One or more comma-separated CoinMarketCap cryptocurrency IDs. Example: "1,2"
slug string no Alternatively pass a comma-separated list of cryptocurrency slugs. Example: "bitcoin,ethereum"
symbol string no Alternatively pass one or more comma-separated cryptocurrency symbols. Example: "BTC,ETH". At least one "id" *or* "slug" *or* "symbol" is required for this request. Please note that starting in the v2 endpoint, due to the fact that a symbol is not unique, if you request by symbol each data response will contain an array of objects containing all of the coins that use each requested symbol. The v1 endpoint will still return a single object, the highest ranked coin using that symbol.
address string no Alternatively pass in a contract address. Example: "0xc40af1e4fecfa05ce6bab79dcd8b373d2e436c4e"
skip_invalid boolean no Pass `true` to relax request validation rules. When requesting records on multiple cryptocurrencies an error is returned if any invalid cryptocurrencies are requested or a cryptocurrency does not have matching records in the requested timeframe. If set to true, invalid lookups will be skipped allowing valid cryptocurrencies to still be returned.
aux string no Optionally specify a comma-separated list of supplemental data fields to return. Pass `urls,logo,description,tags,platform,date_added,notice,status` to include all auxiliary fields.
price_conversion_v1_deprecated Read

Fetch the complete documentation index at: https://pro.coinmarketcap.com/llms.txt Official CoinMarketCap endpoint: GET /v1/tools/price-conversion.

Lua path
app.integrations.coinmarketcap.price_conversion_v1_deprecated
Full name
coinmarketcap.coinmarketcap_get_v1_tools_price_conversion
ParameterTypeRequiredDescription
amount number yes An amount of currency to convert. Example: 10.43
id string no The CoinMarketCap currency ID of the base cryptocurrency or fiat to convert from. Example: "1"
symbol string no Alternatively the currency symbol of the base cryptocurrency or fiat to convert from. Example: "BTC". One "id" *or* "symbol" is required. Please note that starting in the v2 endpoint, due to the fact that a symbol is not unique, if you request by symbol each quote response will contain an array of objects containing all of the coins that use each requested symbol. The v1 endpoint will still return a single object, the highest ranked coin using that symbol.
time string no Optional timestamp (Unix or ISO 8601) to reference historical pricing during conversion. If not passed, the current time will be used. If passed, we'll reference the closest historic values available for this conversion.
convert string no Pass up to 120 comma-separated fiat or cryptocurrency symbols to convert the source amount to.
convert_id string no Optionally calculate market quotes by CoinMarketCap ID instead of symbol. This option is identical to `convert` outside of ID format. Ex: convert_id=1,2781 would replace convert=BTC,USD in your query. This parameter cannot be used when `convert` is used.
pairs_latest_v1_deprecated Read

Fetch the complete documentation index at: https://pro.coinmarketcap.com/llms.txt Official CoinMarketCap endpoint: GET /v1/cryptocurrency/market-pairs/latest.

Lua path
app.integrations.coinmarketcap.pairs_latest_v1_deprecated
Full name
coinmarketcap.coinmarketcap_get_v1_cryptocurrency_market_pairs_latest
ParameterTypeRequiredDescription
id string no A cryptocurrency or fiat currency by CoinMarketCap ID to list market pairs for. Example: "1"
slug string no Alternatively pass a cryptocurrency by slug. Example: "bitcoin"
symbol string no Alternatively pass a cryptocurrency by symbol. Fiat currencies are not supported by this field. Example: "BTC". A single cryptocurrency "id", "slug", *or* "symbol" is required.
start integer no Optionally offset the start (1-based index) of the paginated list of items to return.
limit integer no Optionally specify the number of results to return. Use this parameter and the "start" parameter to determine your own pagination size.
sort_dir string no Optionally specify the sort direction of markets returned.
sort string no Optionally specify the sort order of markets returned. By default we return a strict sort on 24 hour reported volume. Pass `cmc_rank` to return a CMC methodology based sort where markets with excluded volumes are returned last.
aux string no Optionally specify a comma-separated list of supplemental data fields to return. Pass `num_market_pairs,category,fee_type,market_url,currency_name,currency_slug,price_quote,notice,cmc_rank,effective_liquidity,market_score,market_reputation` to include all auxiliary fields.
matched_id string no Optionally include one or more fiat or cryptocurrency IDs to filter market pairs by. For example `?id=1&matched_id=2781` would only return BTC markets that matched: "BTC/USD" or "USD/BTC". This parameter cannot be used when `matched_symbol` is used.
matched_symbol string no Optionally include one or more fiat or cryptocurrency symbols to filter market pairs by. For example `?symbol=BTC&matched_symbol=USD` would only return BTC markets that matched: "BTC/USD" or "USD/BTC". This parameter cannot be used when `matched_id` is used.
category string no The category of trading this market falls under. Spot markets are the most common but options include derivatives and OTC.
fee_type string no The fee type the exchange enforces for this market.
convert string no Optionally calculate market quotes in up to 120 currencies at once by passing a comma-separated list of cryptocurrency or fiat currency symbols. Each additional convert option beyond the first requires an additional call credit. A list of supported fiat options can be found [here](/guides/standards-and-conventions). Each conversion is returned in its own "quote" object.
convert_id string no Optionally calculate market quotes by CoinMarketCap ID instead of symbol. This option is identical to `convert` outside of ID format. Ex: convert_id=1,2781 would replace convert=BTC,USD in your query. This parameter cannot be used when `convert` is used.
ohlcv_historical_v1_deprecated Read

Fetch the complete documentation index at: https://pro.coinmarketcap.com/llms.txt Official CoinMarketCap endpoint: GET /v1/cryptocurrency/ohlcv/historical.

Lua path
app.integrations.coinmarketcap.ohlcv_historical_v1_deprecated
Full name
coinmarketcap.coinmarketcap_get_v1_cryptocurrency_ohlcv_historical
ParameterTypeRequiredDescription
id string no One or more comma-separated CoinMarketCap cryptocurrency IDs. Example: "1,1027"
slug string no Alternatively pass a comma-separated list of cryptocurrency slugs. Example: "bitcoin,ethereum"
symbol string no Alternatively pass one or more comma-separated cryptocurrency symbols. Example: "BTC,ETH". At least one "id" *or* "slug" *or* "symbol" is required for this request.
time_period string no Time period to return OHLCV data for. The default is "daily". If hourly, the open will be 01:00 and the close will be 01:59. If daily, the open will be 00:00:00 for the day and close will be 23:59:99 for the same day. See the main endpoint description for details.
time_start string no Timestamp (Unix or ISO 8601) to start returning OHLCV time periods for. Only the date portion of the timestamp is used for daily OHLCV so it's recommended to send an ISO date format like "2018-09-19" without time.
time_end string no Timestamp (Unix or ISO 8601) to stop returning OHLCV time periods for (inclusive). Optional, if not passed we'll default to the current time. Only the date portion of the timestamp is used for daily OHLCV so it's recommended to send an ISO date format like "2018-09-19" without time.
count number no Optionally limit the number of time periods to return results for. The default is 10 items. The current query limit is 10000 items.
interval string no Optionally adjust the interval that "time_period" is sampled. For example with interval=monthly&time_period=daily you will see a daily OHLCV record for January, February, March and so on. See main endpoint description for available options.
convert string no By default market quotes are returned in USD. Optionally calculate market quotes in up to 3 fiat currencies or cryptocurrencies.
convert_id string no Optionally calculate market quotes by CoinMarketCap ID instead of symbol. This option is identical to `convert` outside of ID format. Ex: convert_id=1,2781 would replace convert=BTC,USD in your query. This parameter cannot be used when `convert` is used.
skip_invalid boolean no Pass `true` to relax request validation rules. When requesting records on multiple cryptocurrencies an error is returned if any invalid cryptocurrencies are requested or a cryptocurrency does not have matching records in the requested timeframe. If set to true, invalid lookups will be skipped allowing valid cryptocurrencies to still be returned.
ohlcv_latest_v1_deprecated Read

Fetch the complete documentation index at: https://pro.coinmarketcap.com/llms.txt Official CoinMarketCap endpoint: GET /v1/cryptocurrency/ohlcv/latest.

Lua path
app.integrations.coinmarketcap.ohlcv_latest_v1_deprecated
Full name
coinmarketcap.coinmarketcap_get_v1_cryptocurrency_ohlcv_latest
ParameterTypeRequiredDescription
id string no One or more comma-separated cryptocurrency CoinMarketCap IDs. Example: 1,2
symbol string no Alternatively pass one or more comma-separated cryptocurrency symbols. Example: "BTC,ETH". At least one "id" *or* "symbol" is required.
convert string no Optionally calculate market quotes in up to 120 currencies at once by passing a comma-separated list of cryptocurrency or fiat currency symbols. Each additional convert option beyond the first requires an additional call credit. A list of supported fiat options can be found [here](/guides/standards-and-conventions). Each conversion is returned in its own "quote" object.
convert_id string no Optionally calculate market quotes by CoinMarketCap ID instead of symbol. This option is identical to `convert` outside of ID format. Ex: convert_id=1,2781 would replace convert=BTC,USD in your query. This parameter cannot be used when `convert` is used.
skip_invalid boolean no Pass `true` to relax request validation rules. When requesting records on multiple cryptocurrencies an error is returned if any invalid cryptocurrencies are requested or a cryptocurrency does not have matching records in the requested timeframe. If set to true, invalid lookups will be skipped allowing valid cryptocurrencies to still be returned.
price_performance_stats_v1_deprecated Read

Fetch the complete documentation index at: https://pro.coinmarketcap.com/llms.txt Official CoinMarketCap endpoint: GET /v1/cryptocurrency/price-performance-stats/latest.

Lua path
app.integrations.coinmarketcap.price_performance_stats_v1_deprecated
Full name
coinmarketcap.coinmarketcap_get_v1_cryptocurrency_price_performance_stats_latest
ParameterTypeRequiredDescription
id string no One or more comma-separated cryptocurrency CoinMarketCap IDs. Example: 1,2
slug string no Alternatively pass a comma-separated list of cryptocurrency slugs. Example: "bitcoin,ethereum"
symbol string no Alternatively pass one or more comma-separated cryptocurrency symbols. Example: "BTC,ETH". At least one "id" *or* "slug" *or* "symbol" is required for this request.
time_period string no Specify one or more comma-delimited time periods to return stats for. `all_time` is the default. Pass `all_time,yesterday,24h,7d,30d,90d,365d` to return all supported time periods. All rolling periods have a rolling close time of the current request time. For example `24h` would have a close time of now and an open time of 24 hours before now. *Please note: `yesterday` is a UTC period and currently does not currently support `high` and `low` timestamps.*
convert string no Optionally calculate quotes in up to 120 currencies at once by passing a comma-separated list of cryptocurrency or fiat currency symbols. Each additional convert option beyond the first requires an additional call credit. A list of supported fiat options can be found [here](/guides/standards-and-conventions). Each conversion is returned in its own "quote" object.
convert_id string no Optionally calculate quotes by CoinMarketCap ID instead of symbol. This option is identical to `convert` outside of ID format. Ex: convert_id=1,2781 would replace convert=BTC,USD in your query. This parameter cannot be used when `convert` is used.
skip_invalid boolean no Pass `true` to relax request validation rules. When requesting records on multiple cryptocurrencies an error is returned if no match is found for 1 or more requested cryptocurrencies. If set to true, invalid lookups will be skipped allowing valid cryptocurrencies to still be returned.
quotes_historical_v1_deprecated Read

Fetch the complete documentation index at: https://pro.coinmarketcap.com/llms.txt Official CoinMarketCap endpoint: GET /v1/cryptocurrency/quotes/historical.

Lua path
app.integrations.coinmarketcap.quotes_historical_v1_deprecated
Full name
coinmarketcap.coinmarketcap_get_v1_cryptocurrency_quotes_historical
ParameterTypeRequiredDescription
id string no One or more comma-separated CoinMarketCap cryptocurrency IDs. Example: "1,2"
symbol string no Alternatively pass one or more comma-separated cryptocurrency symbols. Example: "BTC,ETH". At least one "id" *or* "symbol" is required for this request.
time_start string no Timestamp (Unix or ISO 8601) to start returning quotes for. Optional, if not passed, we'll return quotes calculated in reverse from "time_end".
time_end string no Timestamp (Unix or ISO 8601) to stop returning quotes for (inclusive). Optional, if not passed, we'll default to the current time. If no "time_start" is passed, we return quotes in reverse order starting from this time.
count number no The number of interval periods to return results for. Optional, required if both "time_start" and "time_end" aren't supplied. The default is 10 items. The current query limit is 10000.
interval string no Interval of time to return data points for. See details in endpoint description.
convert string no By default market quotes are returned in USD. Optionally calculate market quotes in up to 3 other fiat currencies or cryptocurrencies.
convert_id string no Optionally calculate market quotes by CoinMarketCap ID instead of symbol. This option is identical to `convert` outside of ID format. Ex: convert_id=1,2781 would replace convert=BTC,USD in your query. This parameter cannot be used when `convert` is used.
aux string no Optionally specify a comma-separated list of supplemental data fields to return. Pass `price,volume,market_cap,circulating_supply,total_supply,quote_timestamp,is_active,is_fiat,search_interval` to include all auxiliary fields.
skip_invalid boolean no Pass `true` to relax request validation rules. When requesting records on multiple cryptocurrencies an error is returned if no match is found for 1 or more requested cryptocurrencies. If set to true, invalid lookups will be skipped allowing valid cryptocurrencies to still be returned.
quotes_latest_v1_deprecated Read

Fetch the complete documentation index at: https://pro.coinmarketcap.com/llms.txt Official CoinMarketCap endpoint: GET /v1/cryptocurrency/quotes/latest.

Lua path
app.integrations.coinmarketcap.quotes_latest_v1_deprecated
Full name
coinmarketcap.coinmarketcap_get_v1_cryptocurrency_quotes_latest
ParameterTypeRequiredDescription
id string no One or more comma-separated cryptocurrency CoinMarketCap IDs. Example: 1,2
slug string no Alternatively pass a comma-separated list of cryptocurrency slugs. Example: "bitcoin,ethereum"
symbol string no Alternatively pass one or more comma-separated cryptocurrency symbols. Example: "BTC,ETH". At least one "id" *or* "slug" *or* "symbol" is required for this request.
convert string no Optionally calculate market quotes in up to 120 currencies at once by passing a comma-separated list of cryptocurrency or fiat currency symbols. Each additional convert option beyond the first requires an additional call credit. A list of supported fiat options can be found [here](/guides/standards-and-conventions). Each conversion is returned in its own "quote" object.
convert_id string no Optionally calculate market quotes by CoinMarketCap ID instead of symbol. This option is identical to `convert` outside of ID format. Ex: convert_id=1,2781 would replace convert=BTC,USD in your query. This parameter cannot be used when `convert` is used.
aux string no Optionally specify a comma-separated list of supplemental data fields to return. Pass `num_market_pairs,cmc_rank,date_added,tags,platform,max_supply,circulating_supply,total_supply,market_cap_by_total_supply,volume_24h_reported,volume_7d,volume_7d_reported,volume_30d,volume_30d_reported,is_active,is_fiat` to include all auxiliary fields.
skip_invalid boolean no Pass `true` to relax request validation rules. When requesting records on multiple cryptocurrencies an error is returned if no match is found for 1 or more requested cryptocurrencies. If set to true, invalid lookups will be skipped allowing valid cryptocurrencies to still be returned.
quotes_historical_v2 Read

Fetch the complete documentation index at: https://pro.coinmarketcap.com/llms.txt Official CoinMarketCap endpoint: GET /v2/cryptocurrency/quotes/historical.

Lua path
app.integrations.coinmarketcap.quotes_historical_v2
Full name
coinmarketcap.coinmarketcap_get_v2_cryptocurrency_quotes_historical
ParameterTypeRequiredDescription
id string no One or more comma-separated CoinMarketCap cryptocurrency IDs. Example: "1,2"
symbol string no Alternatively pass one or more comma-separated cryptocurrency symbols. Example: "BTC,ETH". At least one "id" *or* "symbol" is required for this request.
time_start string no Timestamp (Unix or ISO 8601) to start returning quotes for. Optional, if not passed, we'll return quotes calculated in reverse from "time_end".
time_end string no Timestamp (Unix or ISO 8601) to stop returning quotes for (inclusive). Optional, if not passed, we'll default to the current time. If no "time_start" is passed, we return quotes in reverse order starting from this time.
count number no The number of interval periods to return results for. Optional, required if both "time_start" and "time_end" aren't supplied. The default is 10 items. The current query limit is 10000.
interval string no Interval of time to return data points for. See details in endpoint description.
convert string no By default market quotes are returned in USD. Optionally calculate market quotes in up to 3 other fiat currencies or cryptocurrencies.
convert_id string no Optionally calculate market quotes by CoinMarketCap ID instead of symbol. This option is identical to `convert` outside of ID format. Ex: convert_id=1,2781 would replace convert=BTC,USD in your query. This parameter cannot be used when `convert` is used.
aux string no Optionally specify a comma-separated list of supplemental data fields to return. Pass `price,volume,market_cap,circulating_supply,total_supply,quote_timestamp,is_active,is_fiat,search_interval` to include all auxiliary fields.
skip_invalid boolean no Pass `true` to relax request validation rules. When requesting records on multiple cryptocurrencies an error is returned if no match is found for 1 or more requested cryptocurrencies. If set to true, invalid lookups will be skipped allowing valid cryptocurrencies to still be returned.
quotes_latest_v2 Read

Fetch the complete documentation index at: https://pro.coinmarketcap.com/llms.txt Official CoinMarketCap endpoint: GET /v2/cryptocurrency/quotes/latest.

Lua path
app.integrations.coinmarketcap.quotes_latest_v2
Full name
coinmarketcap.coinmarketcap_get_v2_cryptocurrency_quotes_latest
ParameterTypeRequiredDescription
id string no One or more comma-separated cryptocurrency CoinMarketCap IDs. Example: 1,2
slug string no Alternatively pass a comma-separated list of cryptocurrency slugs. Example: "bitcoin,ethereum"
symbol string no Alternatively pass one or more comma-separated cryptocurrency symbols. Example: "BTC,ETH". At least one "id" *or* "slug" *or* "symbol" is required for this request.
convert string no Optionally calculate market quotes in up to 120 currencies at once by passing a comma-separated list of cryptocurrency or fiat currency symbols. Each additional convert option beyond the first requires an additional call credit. A list of supported fiat options can be found [here](/guides/standards-and-conventions). Each conversion is returned in its own "quote" object.
convert_id string no Optionally calculate market quotes by CoinMarketCap ID instead of symbol. This option is identical to `convert` outside of ID format. Ex: convert_id=1,2781 would replace convert=BTC,USD in your query. This parameter cannot be used when `convert` is used.
aux string no Optionally specify a comma-separated list of supplemental data fields to return. Pass `num_market_pairs,cmc_rank,date_added,tags,platform,max_supply,circulating_supply,total_supply,market_cap_by_total_supply,volume_24h_reported,volume_7d,volume_7d_reported,volume_30d,volume_30d_reported,is_active,is_fiat` to include all auxiliary fields.
skip_invalid boolean no Pass `true` to relax request validation rules. When requesting records on multiple cryptocurrencies an error is returned if no match is found for 1 or more requested cryptocurrencies. If set to true, invalid lookups will be skipped allowing valid cryptocurrencies to still be returned.
fcas_listings_latest_deprecated Read

Fetch the complete documentation index at: https://pro.coinmarketcap.com/llms.txt Official CoinMarketCap endpoint: GET /v1/partners/flipside-crypto/fcas/listings/latest.

Lua path
app.integrations.coinmarketcap.fcas_listings_latest_deprecated
Full name
coinmarketcap.coinmarketcap_get_v1_partners_flipside_crypto_fcas_listings_latest
ParameterTypeRequiredDescription
start integer no Optionally offset the start (1-based index) of the paginated list of items to return.
limit integer no Optionally specify the number of results to return. Use this parameter and the "start" parameter to determine your own pagination size.
aux string no Optionally specify a comma-separated list of supplemental data fields to return. Pass `point_change_24h,percent_change_24h` to include all auxiliary fields.
fcas_quotes_latest_deprecated Read

Fetch the complete documentation index at: https://pro.coinmarketcap.com/llms.txt Official CoinMarketCap endpoint: GET /v1/partners/flipside-crypto/fcas/quotes/latest.

Lua path
app.integrations.coinmarketcap.fcas_quotes_latest_deprecated
Full name
coinmarketcap.coinmarketcap_get_v1_partners_flipside_crypto_fcas_quotes_latest
ParameterTypeRequiredDescription
id string no One or more comma-separated cryptocurrency CoinMarketCap IDs. Example: 1,2
slug string no Alternatively pass a comma-separated list of cryptocurrency slugs. Example: "bitcoin,ethereum"
symbol string no Alternatively pass one or more comma-separated cryptocurrency symbols. Example: "BTC,ETH". At least one "id" *or* "slug" *or* "symbol" is required for this request.
aux string no Optionally specify a comma-separated list of supplemental data fields to return. Pass `point_change_24h,percent_change_24h` to include all auxiliary fields.
trades_latest Read

Fetch the complete documentation index at: https://pro.coinmarketcap.com/llms.txt Official CoinMarketCap endpoint: GET /v4/dex/pairs/trade/latest.

Lua path
app.integrations.coinmarketcap.trades_latest
Full name
coinmarketcap.coinmarketcap_get_v4_dex_pairs_trade_latest
ParameterTypeRequiredDescription
contract_address string no One or more comma-separated contract addresses.
network_id string no One CoinMarketCap cryptocurrency network id.
network_slug string no Alternatively, one network names in URL friendly shorthand "slug" format (all lowercase, spaces replaced with hyphens).
aux string no Default:`""` Valid values: `"transaction_hash"` `"blockchain_explorer_link"` Optionally specify a comma-separated list of supplemental data fields to return.
convert_id string no Optionally calculate market quotes in up to 30 currencies at once by passing a comma-separated list of cryptocurrency or fiat currency IDs. Each additional convert option beyond the first requires an additional call credit. A list of supported fiat options can be found in our API document. Each conversion is returned in its own "trade" object.
skip_invalid string no Pass true to relax request validation rules. When requesting records on multiple spot pairs an error is returned if no match is found for 1 or more requested spot pairs. If set to true, invalid lookups will be skipped allowing valid spot pairs to still be returned.
reverse_order string no Pass true to invert the order of a spot pair. For example, a trading pair is set up as Token B/Token A in the contract and is commonly referred to as Token A/Token B. Using reverse_order would change the order to reflect the true Token B/Token A pairing as it exists in the pool.
ohlcv_latest Read

Fetch the complete documentation index at: https://pro.coinmarketcap.com/llms.txt Official CoinMarketCap endpoint: GET /v4/dex/pairs/ohlcv/latest.

Lua path
app.integrations.coinmarketcap.ohlcv_latest
Full name
coinmarketcap.coinmarketcap_get_v4_dex_pairs_ohlcv_latest
ParameterTypeRequiredDescription
contract_address string no One or more comma-separated contract addresses.
network_id string no One or more CoinMarketCap cryptocurrency network ids
network_slug string no Alternatively, one network names in URL friendly shorthand "slug" format (all lowercase, spaces replaced with hyphens).
aux string no Default:`""` Valid values: `"pool_created"` `"percent_pooled_base_asset"` `"num_transactions_24h"` `"pool_base_asset"` `"pool_quote_asset"` `"24h_volume_quote_asset"` `"total_supply_quote_asset"` `"total_supply_base_asset"` `"holders"` `"buy_tax"` `"sell_tax"` `"security_scan"` `"24h_no_of_buys"` `"24h_no_of_sells"` `"24h_buy_volume"` `"24h_sell_volume"` Optionally specify a comma-separated list of supplemental data fields to return.
convert_id string no Optionally calculate market quotes by CoinMarketCap ID instead of symbol. This option is identical to convert outside of ID format. Ex: convert_id=1,2781 would replace convert=BTC,USD in your query. This parameter cannot be used when convert is used.
skip_invalid string no Pass true to relax request validation rules. When requesting records on multiple spot pairs an error is returned if no match is found for 1 or more requested spot pairs. If set to true, invalid lookups will be skipped allowing valid spot pairs to still be returned.
reverse_order string no Pass true to invert the order of a spot pair. For example, a trading pair is set up as Token B/Token A in the contract and is commonly referred to as Token A/Token B. Using reverse_order would change the order to reflect the true Token B/Token A pairing as it exists in the pool.
ohlcv_historical Read

Fetch the complete documentation index at: https://pro.coinmarketcap.com/llms.txt Official CoinMarketCap endpoint: GET /v4/dex/pairs/ohlcv/historical.

Lua path
app.integrations.coinmarketcap.ohlcv_historical
Full name
coinmarketcap.coinmarketcap_get_v4_dex_pairs_ohlcv_historical
ParameterTypeRequiredDescription
contract_address string no One contract address. Example:"0x88e6a0c2ddd26feeb64f039a2c41296fcb3f5640". If network/dex/base asset/quote asset information is passed, contract address cannot be passed. Note: contract_address is case sensitive for all non-EVM chains and not case sensitive for all EVM chains. EVM chains contract address addresses begin with 0x, and are followed by 40 alphanumeric characters(numerals and letters)
network_id string no One or more CoinMarketCap cryptocurrency network ids
network_slug string no Alternatively, one network names in URL friendly shorthand "slug" format (all lowercase, spaces replaced with hyphens).
time_period string no Default:`"daily"` Valid values: `"daily"` `"hourly"` `"1m"` `"5m"` `"15m"` `"4h"` Time period to return OHLCV data for. If hourly, the open will be 01:00 and the close will be 01:59. If daily, the open will be 00:00:00 for the day and close will be 23:59:99 for the same day. See the main endpoint description for details.
time_start string no Timestamp (Unix or ISO 8601) to start returning OHLCV time periods for. Only the date portion of the timestamp is used for daily OHLCV so it's recommended to send an ISO date format like "2018-09-19" without time.
time_end string no Timestamp (Unix or ISO 8601) to stop returning OHLCV time periods for (inclusive). Optional, if not passed we'll default to the current time. Only the date portion of the timestamp is used for daily OHLCV so it's recommended to send an ISO date format like "2018-09-19" without time.
count string no Optionally limit the number of time periods to return results for. The default is 10 items. The current query limit is 500 items.
interval string no Default:`"daily"` Valid values: `"1m"` `"5m"` `"15m"` `"30m"` `"1h"` `"4h"` `"8h"` `"12h"` `"daily"` `"weekly"` `"monthly"` Optionally adjust the interval that "time_period" is sampled. For example with interval=monthly&time_period=daily you will see a daily OHLCV record for January, February, March and so on. See main endpoint description for available options.
aux string no Default:`""` Valid values: `"pool_created"` `"percent_pooled_base_asset"` `"num_transactions_24h"` `"pool_base_asset"` `"pool_quote_asset"` `"24h_volume_quote_asset"` `"total_supply_quote_asset"` `"total_supply_base_asset"` `"holders"` `"buy_tax"` `"sell_tax"` `"security_scan"` `"24h_no_of_buys"` `"24h_no_of_sells"` `"24h_buy_volume"` `"24h_sell_volume"` Optionally specify a comma-separated list of supplemental data fields to return.
convert_id string no Optionally calculate market quotes by CoinMarketCap ID instead of symbol. This option is identical to convert outside of ID format. Ex: convert_id=1,2781 would replace convert=BTC,USD in your query. This parameter cannot be used when convert is used.
skip_invalid string no Pass true to relax request validation rules. When requesting records on multiple spot pairs an error is returned if no match is found for 1 or more requested spot pairs. If set to true, invalid lookups will be skipped allowing valid spot pairs to still be returned.
reverse_order string no Pass true to invert the order of a spot pair. For example, a trading pair is set up as Token B/Token A in the contract and is commonly referred to as Token A/Token B. Using reverse_order would change the order to reflect the true Token B/Token A pairing as it exists in the pool.
id_map Read

Fetch the complete documentation index at: https://pro.coinmarketcap.com/llms.txt Official CoinMarketCap endpoint: GET /v4/dex/networks/list.

Lua path
app.integrations.coinmarketcap.id_map
Full name
coinmarketcap.coinmarketcap_get_v4_dex_networks_list
ParameterTypeRequiredDescription
start string no Optionally offset the start (1-based index) of the paginated list of items to return.
limit string no Optionally specify the number of results to return. Use this parameter and the "start" parameter to determine your own pagination size.
sort string no Default:`"id"` Valid values: `"id"` `"name"` What field to sort the list of networks by.
sort_dir string no Default:`"desc"` Valid values: `"desc"` `"asc"` The direction in which to order networks against the specified sort.
aux string no Default:`""` Valid values: `"alternativeName"` `"cryptocurrencyId"` `"cryptocurrenySlug"` `"wrappedTokenId"` `"wrappedTokenSlug"` `"tokenExplorerUrl"` `"poolExplorerUrl"` `"transactionHashUrl"` Optionally specify a comma-separated list of supplemental data fields to return.
dex_listings_latest Read

Fetch the complete documentation index at: https://pro.coinmarketcap.com/llms.txt Official CoinMarketCap endpoint: GET /v4/dex/listings/quotes.

Lua path
app.integrations.coinmarketcap.dex_listings_latest
Full name
coinmarketcap.coinmarketcap_get_v4_dex_listings_quotes
ParameterTypeRequiredDescription
start string no Optionally offset the start (1-based index) of the paginated list of items to return.
limit string no Optionally specify the number of results to return. Use this parameter and the "start" parameter to determine your own pagination size.
sort string no Default:`"volume_24h"` Valid values: `"name"` `"volume_24h"` `"market_share"` `"num_markets"` What field to sort the list of exchanges by.
sort_dir string no Default:`"desc"` Valid values: `"desc"` `"asc"` The direction in which to order exchanges against the specified sort.
type string no Default:`"all"` Valid values: `"all"` `"orderbook"` `"swap"` `"aggregator"` The category for this exchange.
aux string no Default:`""` Valid values: `"date_launched"` Optionally specify a comma-separated list of supplemental data fields to return.
convert_id string no Optionally calculate market quotes in up to 30 currencies at once by passing a comma-separated list of cryptocurrency or fiat currency IDs. Each additional convert option beyond the first requires an additional call credit. A list of supported fiat options can be found in our API document. Each conversion is returned in its own "quote" object.
dex_metadata Read

Fetch the complete documentation index at: https://pro.coinmarketcap.com/llms.txt Official CoinMarketCap endpoint: GET /v4/dex/listings/info.

Lua path
app.integrations.coinmarketcap.dex_metadata
Full name
coinmarketcap.coinmarketcap_get_v4_dex_listings_info
ParameterTypeRequiredDescription
id string no One or more comma-separated CoinMarketCap cryptocurrency exchange ids.
aux string no Default:`""` Valid values: `"urls"` `"logo"` `"description"` `"date_launched"` `"notice"` Optionally specify a comma-separated list of supplemental data fields to return.