{"openapi":"3.1.0","info":{"title":"Coinranking (BYOK) API","version":"0.1.0","description":"Coinranking (BYOK) lets an AI assistant read your own Coinranking data through the Coinranking API with a key you supply (Coinranking API key). Read-only: 8 tools (list_coins, list_trending_coins, get_coin, get_coin_price, get_coin_price_history, get_global_stats, list_reference_currencies, search_suggestions). The BYOK key travels with each request, is used for that one call only and is never...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-coinranking.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-coinranking/docs"},"termsOfService":"https://connectorbay.com/byok-coinranking/terms"},"servers":[{"url":"https://byok-coinranking.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-coinranking/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/list_coins":{"post":{"operationId":"list_coins","summary":"List coins ranked by market cap (or price, volume, change, listing date) with price, market cap, 24 hour volume, change ","description":"List coins ranked by market cap (or price, volume, change, listing date) with price, market cap, 24 hour volume, change over the chosen window, rank and tier. Tier 1 and 2 only by default. Also returns market-wide counts. Use for \"What are the top 10 coins by market cap on Coinranking\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"order_by":{"anyOf":[{"enum":["marketCap","price","24hVolume","change","listedAt"],"type":"string"},{"type":"null"}],"default":null,"description":"Sort field: marketCap (default), price, 24hVolume, change or listedAt.","title":"Order By"},"order_direction":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":null,"description":"desc (default) or asc.","title":"Order Direction"},"symbol":{"anyOf":[{"maxLength":20,"type":"string"},{"type":"null"}],"default":null,"description":"Only coins with this symbol, for example 'ETH'. Symbols are not unique.","title":"Symbol"},"tag":{"anyOf":[{"maxLength":20,"type":"string"},{"type":"null"}],"default":null,"description":"Only coins with this tag: defi, stablecoin, nft, dex, exchange, staking, dao, meme, privacy, metaverse, gaming, wrapped, layer-1, layer-2, fan-token, football-club, web3 or social.","title":"Tag"},"tier":{"anyOf":[{"enum":["1","2","3"],"type":"string"},{"type":"null"}],"default":null,"description":"Only this coin tier (1 is the highest quality; 3 must be asked for explicitly).","title":"Tier"},"time_period":{"anyOf":[{"enum":["1h","3h","12h","24h","7d","30d","3m","1y","3y","5y"],"type":"string"},{"type":"null"}],"default":null,"description":"Window for the change percentage and sparkline: 1h, 3h, 12h, 24h (default), 7d, 30d, 3m, 1y, 3y or 5y. The free plan reaches back 1y.","title":"Time Period"},"reference_currency_uuid":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"UUID of the currency prices are quoted in (default US Dollar, yhjMzLPhuIDl). Find UUIDs with list_reference_currencies.","title":"Reference Currency Uuid"},"limit":{"anyOf":[{"maximum":50,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many coins to return (1 to 50 here; default 10). Each coin carries a price sparkline, so keep this small.","title":"Limit"},"offset":{"anyOf":[{"maximum":5000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Number of coins to skip (0 to 5000), for paging.","title":"Offset"}},"title":"list_coinsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_trending_coins":{"post":{"operationId":"list_trending_coins","summary":"List the coins currently trending on Coinranking, ranked by user engagement, with price, change and rank. Tiers 1 to 3 b","description":"List the coins currently trending on Coinranking, ranked by user engagement, with price, change and rank. Tiers 1 to 3 by default. Use for \"Which coins are trending on Coinranking right now\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"time_period":{"anyOf":[{"enum":["1h","3h","12h","24h","7d","30d","3m","1y","3y","5y"],"type":"string"},{"type":"null"}],"default":null,"description":"Window for the change percentage and sparkline: 1h, 3h, 12h, 24h (default), 7d, 30d, 3m, 1y, 3y or 5y. The free plan reaches back 1y.","title":"Time Period"},"reference_currency_uuid":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"UUID of the currency prices are quoted in (default US Dollar, yhjMzLPhuIDl). Find UUIDs with list_reference_currencies.","title":"Reference Currency Uuid"},"tier":{"anyOf":[{"enum":["1","2","3"],"type":"string"},{"type":"null"}],"default":null,"description":"Only this coin tier.","title":"Tier"},"limit":{"anyOf":[{"maximum":50,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many coins to return (1 to 50 here; default 10). Each coin carries a price sparkline, so keep this small.","title":"Limit"},"offset":{"anyOf":[{"maximum":5000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Number of coins to skip, for paging.","title":"Offset"}},"title":"list_trending_coinsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_coin":{"post":{"operationId":"get_coin","summary":"Get one coin's details: description, website, supply, price, market cap, rank, all-time high, number of markets and exch","description":"Get one coin's details: description, website, supply, price, market cap, rank, all-time high, number of markets and exchanges, and contract addresses. Use for \"Tell me about Ethereum on Coinranking: price, supply and all-time high\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"uuid":{"description":"Coinranking coin UUID, for example 'Qwsogvtv82FCd' for Bitcoin. Find UUIDs with list_coins or search.","maxLength":200,"title":"Uuid","type":"string"},"time_period":{"anyOf":[{"enum":["1h","3h","12h","24h","7d","30d","3m","1y","3y","5y"],"type":"string"},{"type":"null"}],"default":null,"description":"Window for the change percentage and sparkline: 1h, 3h, 12h, 24h (default), 7d, 30d, 3m, 1y, 3y or 5y. The free plan reaches back 1y.","title":"Time Period"},"reference_currency_uuid":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"UUID of the currency prices are quoted in (default US Dollar, yhjMzLPhuIDl). Find UUIDs with list_reference_currencies.","title":"Reference Currency Uuid"}},"required":["uuid"],"title":"get_coinArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_coin_price":{"post":{"operationId":"get_coin_price","summary":"Get a coin's price at one moment (nearest minute, hour or day point to the timestamp); the current price when no timesta","description":"Get a coin's price at one moment (nearest minute, hour or day point to the timestamp); the current price when no timestamp is given. Use for \"What was the Bitcoin price on 1 January 2025\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"uuid":{"description":"Coinranking coin UUID, for example 'Qwsogvtv82FCd' for Bitcoin. Find UUIDs with list_coins or search.","maxLength":200,"title":"Uuid","type":"string"},"reference_currency_uuid":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"UUID of the currency prices are quoted in (default US Dollar, yhjMzLPhuIDl). Find UUIDs with list_reference_currencies.","title":"Reference Currency Uuid"},"timestamp":{"anyOf":[{"maximum":4102444800,"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Epoch time in seconds. Omit for the latest price.","title":"Timestamp"}},"required":["uuid"],"title":"get_coin_priceArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_coin_price_history":{"post":{"operationId":"get_coin_price_history","summary":"Get a coin's price history for a window as timestamped price points (for charts), plus the percentage change over the wi","description":"Get a coin's price history for a window as timestamped price points (for charts), plus the percentage change over the window. Use for \"How did the Bitcoin price move over the last 7 days\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"uuid":{"description":"Coinranking coin UUID, for example 'Qwsogvtv82FCd' for Bitcoin. Find UUIDs with list_coins or search.","maxLength":200,"title":"Uuid","type":"string"},"time_period":{"anyOf":[{"enum":["1h","3h","12h","24h","7d","30d","3m","1y","3y","5y"],"type":"string"},{"type":"null"}],"default":null,"description":"Window for the change percentage and sparkline: 1h, 3h, 12h, 24h (default), 7d, 30d, 3m, 1y, 3y or 5y. The free plan reaches back 1y.","title":"Time Period"},"reference_currency_uuid":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"UUID of the currency prices are quoted in (default US Dollar, yhjMzLPhuIDl). Find UUIDs with list_reference_currencies.","title":"Reference Currency Uuid"}},"required":["uuid"],"title":"get_coin_price_historyArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_global_stats":{"post":{"operationId":"get_global_stats","summary":"Get global crypto market statistics: total coins, markets and exchanges, total market cap and 24 hour volume, Bitcoin do","description":"Get global crypto market statistics: total coins, markets and exchanges, total market cap and 24 hour volume, Bitcoin dominance, best and newest coins. Use for \"What is the total crypto market cap and Bitcoin dominance\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"reference_currency_uuid":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"UUID of the currency prices are quoted in (default US Dollar, yhjMzLPhuIDl). Find UUIDs with list_reference_currencies.","title":"Reference Currency Uuid"}},"title":"get_global_statsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_reference_currencies":{"post":{"operationId":"list_reference_currencies","summary":"List currencies prices can be quoted in (fiat, coins, commodities, indices, stocks) with their UUIDs, symbols and signs.","description":"List currencies prices can be quoted in (fiat, coins, commodities, indices, stocks) with their UUIDs, symbols and signs. Can search by name or symbol. Use for \"What is the Coinranking UUID of the euro\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"search":{"anyOf":[{"maxLength":50,"type":"string"},{"type":"null"}],"default":null,"description":"Filter by currency name or symbol, for example 'EUR'.","title":"Search"},"type":{"anyOf":[{"enum":["coin","fiat","denominator","commodities","indices","stocks"],"type":"string"},{"type":"null"}],"default":null,"description":"Only this type: coin, fiat, denominator, commodities, indices or stocks.","title":"Type"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many currencies (1 to 100, default 20).","title":"Limit"},"offset":{"anyOf":[{"maximum":5000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Number to skip, for paging.","title":"Offset"}},"title":"list_reference_currenciesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/search_suggestions":{"post":{"operationId":"search_suggestions","summary":"Search Coinranking for coins, exchanges, markets, fiat currencies and categories by name, symbol or contract address. Us","description":"Search Coinranking for coins, exchanges, markets, fiat currencies and categories by name, symbol or contract address. Use for \"Search Coinranking for anything matching 'solana'\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"query":{"description":"Part of a name or symbol, or a full contract address.","maxLength":100,"title":"Query","type":"string"},"types":{"anyOf":[{"enum":["coins","exchanges","markets","fiat","categories","commodities","indices","stocks","all"],"type":"string"},{"type":"null"}],"default":"all","description":"Which buckets to search: coins, exchanges, markets, fiat, categories, commodities, indices, stocks or all (default).","title":"Types"},"reference_currency_uuid":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"UUID of the currency prices are quoted in (default US Dollar, yhjMzLPhuIDl). Find UUIDs with list_reference_currencies.","title":"Reference Currency Uuid"}},"required":["query"],"title":"search_suggestionsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}