{ "variable": [ { "id": "baseUrl", "key": "baseUrl", "type": "string", "name": "string", "value": "https:\/\/bitculator.com" } ], "info": { "name": "Bitculator Data API", "_postman_id": "57fcb3d7-1f1b-4acd-9bdc-6f02d5021eff", "description": "Programmatic access to Bitculator market data: coins, prices, history, exchanges, trust scores, tickers, pairs, wallets, sentiment, technical indicators, liquidations, editorial content, and calculators.", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "Coins", "description": "\nRanked coin and token market data: paginated listings, single-coin detail, movers\n(gainers\/losers), recently-added, trending, and per-coin time series. Prices,\nmarketcap and supply are decimal STRINGS (floats can't carry market precision);\npercentage changes, ranks and counts are numbers.", "item": [ { "name": "List coins", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/coins", "query": [ { "key": "page", "value": "1", "description": "Page number (1-based). Must be at least 1.", "disabled": false }, { "key": "per_page", "value": "50", "description": "Rows per page. The cap is plan-based (Free 100, Starter\/Pro 250); exceeding it returns 422 rather than clamping. Must be at least 1. Must not be greater than 100.", "disabled": false }, { "key": "type", "value": "coin", "description": "Restrict to a single asset type: coin or token.", "disabled": false }, { "key": "status", "value": "active", "description": "Listing status: active, delisted, untracked, progressing, awaiting or preparing. Defaults to all public statuses.", "disabled": false }, { "key": "search", "value": "bitcoin", "description": "Free-text match on name or symbol. Must not be greater than 100 characters.", "disabled": false }, { "key": "min_price", "value": "0.5", "description": "Only coins priced at or above this USD value. Must be at least 0.", "disabled": false }, { "key": "max_price", "value": "100000", "description": "Only coins priced at or below this USD value. Must be at least 0.", "disabled": false }, { "key": "min_marketcap", "value": "1000000", "description": "Only coins with a USD marketcap at or above this value. Must be at least 0.", "disabled": false }, { "key": "max_marketcap", "value": "5000000000000", "description": "Only coins with a USD marketcap at or below this value. Must be at least 0.", "disabled": false }, { "key": "min_volume", "value": "1000000", "description": "Only coins with 24h USD volume at or above this value. Must be at least 0.", "disabled": false }, { "key": "max_volume", "value": "100000000000", "description": "Only coins with 24h USD volume at or below this value. Must be at least 0.", "disabled": false }, { "key": "ids", "value": "38,39", "description": "Filter to specific coin ids (CSV, up to 100 selectors combined with slugs\/symbols). Must not be greater than 1000 characters.", "disabled": false }, { "key": "slugs", "value": "bitcoin,ethereum", "description": "Filter to specific coin slugs (CSV, up to 100 selectors combined). Must not be greater than 2000 characters.", "disabled": false }, { "key": "symbols", "value": "BTC,ETH", "description": "Filter to specific coin symbols (CSV, case-insensitive, up to 100 selectors combined). Must not be greater than 1000 characters.", "disabled": false }, { "key": "sort", "value": "-marketcap", "description": "Comma-separated sort fields; prefix with - for descending. Sortable: marketcap, rank, price, volume_24h, change_24h, change_7d. Must not be greater than 100 characters.", "disabled": false }, { "key": "interval", "value": "24h", "description": "Movers window for \/coins\/gainers and \/coins\/losers only: 24h or 7d.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/coins?page=1&per_page=50&type=coin&status=active&search=bitcoin&min_price=0.5&max_price=100000&min_marketcap=1000000&max_marketcap=5000000000000&min_volume=1000000&max_volume=100000000000&ids=38%2C39&slugs=bitcoin%2Cethereum&symbols=BTC%2CETH&sort=-marketcap&interval=24h" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Ranked coins with prices, filters and selectors, paginated with Laravel's\n`links` + `meta` envelope. Prices, marketcap and circulating_supply are decimal\nstrings; changes and ranks are numbers." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":38,\"slug\":\"bitcoin\",\"name\":\"Bitcoin\",\"symbol\":\"BTC\",\"rank\":1,\"price\":\"63520.780763913\",\"marketcap\":1264646594448.5,\"volume_24h\":5345161962,\"change_24h\":1.35,\"change_7d\":4.98,\"change_rank_24h\":0,\"change_rank_7d\":0,\"circulating_supply\":\"19909179\",\"logo\":\"https:\/\/bitculator.com\/storage\/media\/logo\/bitcoin.png\",\"listed_at\":\"2025-03-15T17:00:43+00:00\",\"last_updated\":\"2026-06-27T10:34:17+00:00\"}],\"links\":{\"first\":\"https:\/\/bitculator.com\/api\/v1\/coins?page=1\",\"last\":\"https:\/\/bitculator.com\/api\/v1\/coins?page=3\",\"prev\":null,\"next\":\"https:\/\/bitculator.com\/api\/v1\/coins?page=2\"},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":3,\"per_page\":50,\"to\":50,\"total\":134}}", "name": "" }, { "header": [], "code": 422, "body": "{\"error\":{\"code\":\"validation\",\"message\":\"The request parameters are invalid.\",\"details\":{\"errors\":{\"per_page\":[\"The per page must not be greater than 250.\"]}}}}", "name": "" } ] }, { "name": "Recently added coins", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/coins\/recently-added", "query": [ { "key": "page", "value": "1", "description": "Page number (1-based). Must be at least 1.", "disabled": false }, { "key": "per_page", "value": "50", "description": "Rows per page. The cap is plan-based (Free 100, Starter\/Pro 250); exceeding it returns 422 rather than clamping. Must be at least 1. Must not be greater than 100.", "disabled": false }, { "key": "type", "value": "coin", "description": "Restrict to a single asset type: coin or token.", "disabled": false }, { "key": "status", "value": "active", "description": "Listing status: active, delisted, untracked, progressing, awaiting or preparing. Defaults to all public statuses.", "disabled": false }, { "key": "search", "value": "bitcoin", "description": "Free-text match on name or symbol. Must not be greater than 100 characters.", "disabled": false }, { "key": "min_price", "value": "0.5", "description": "Only coins priced at or above this USD value. Must be at least 0.", "disabled": false }, { "key": "max_price", "value": "100000", "description": "Only coins priced at or below this USD value. Must be at least 0.", "disabled": false }, { "key": "min_marketcap", "value": "1000000", "description": "Only coins with a USD marketcap at or above this value. Must be at least 0.", "disabled": false }, { "key": "max_marketcap", "value": "5000000000000", "description": "Only coins with a USD marketcap at or below this value. Must be at least 0.", "disabled": false }, { "key": "min_volume", "value": "1000000", "description": "Only coins with 24h USD volume at or above this value. Must be at least 0.", "disabled": false }, { "key": "max_volume", "value": "100000000000", "description": "Only coins with 24h USD volume at or below this value. Must be at least 0.", "disabled": false }, { "key": "ids", "value": "38,39", "description": "Filter to specific coin ids (CSV, up to 100 selectors combined with slugs\/symbols). Must not be greater than 1000 characters.", "disabled": false }, { "key": "slugs", "value": "bitcoin,ethereum", "description": "Filter to specific coin slugs (CSV, up to 100 selectors combined). Must not be greater than 2000 characters.", "disabled": false }, { "key": "symbols", "value": "BTC,ETH", "description": "Filter to specific coin symbols (CSV, case-insensitive, up to 100 selectors combined). Must not be greater than 1000 characters.", "disabled": false }, { "key": "sort", "value": "-marketcap", "description": "Comma-separated sort fields; prefix with - for descending. Sortable: marketcap, rank, price, volume_24h, change_24h, change_7d. Must not be greater than 100 characters.", "disabled": false }, { "key": "interval", "value": "24h", "description": "Movers window for \/coins\/gainers and \/coins\/losers only: 24h or 7d.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/coins\/recently-added?page=1&per_page=50&type=coin&status=active&search=bitcoin&min_price=0.5&max_price=100000&min_marketcap=1000000&max_marketcap=5000000000000&min_volume=1000000&max_volume=100000000000&ids=38%2C39&slugs=bitcoin%2Cethereum&symbols=BTC%2CETH&sort=-marketcap&interval=24h" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Newest listings \u2014 sorted by status_updated_at (the went-active timestamp;\ncreated_at is the crawl date, which predates listing by arbitrary amounts).\nSame row shape and pagination envelope as `List coins`." }, "response": [] }, { "name": "Top gainers", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/coins\/gainers", "query": [ { "key": "page", "value": "1", "description": "Page number (1-based). Must be at least 1.", "disabled": false }, { "key": "per_page", "value": "50", "description": "Rows per page. The cap is plan-based (Free 100, Starter\/Pro 250); exceeding it returns 422 rather than clamping. Must be at least 1. Must not be greater than 100.", "disabled": false }, { "key": "type", "value": "coin", "description": "Restrict to a single asset type: coin or token.", "disabled": false }, { "key": "status", "value": "active", "description": "Listing status: active, delisted, untracked, progressing, awaiting or preparing. Defaults to all public statuses.", "disabled": false }, { "key": "search", "value": "bitcoin", "description": "Free-text match on name or symbol. Must not be greater than 100 characters.", "disabled": false }, { "key": "min_price", "value": "0.5", "description": "Only coins priced at or above this USD value. Must be at least 0.", "disabled": false }, { "key": "max_price", "value": "100000", "description": "Only coins priced at or below this USD value. Must be at least 0.", "disabled": false }, { "key": "min_marketcap", "value": "1000000", "description": "Only coins with a USD marketcap at or above this value. Must be at least 0.", "disabled": false }, { "key": "max_marketcap", "value": "5000000000000", "description": "Only coins with a USD marketcap at or below this value. Must be at least 0.", "disabled": false }, { "key": "min_volume", "value": "1000000", "description": "Only coins with 24h USD volume at or above this value. Must be at least 0.", "disabled": false }, { "key": "max_volume", "value": "100000000000", "description": "Only coins with 24h USD volume at or below this value. Must be at least 0.", "disabled": false }, { "key": "ids", "value": "38,39", "description": "Filter to specific coin ids (CSV, up to 100 selectors combined with slugs\/symbols). Must not be greater than 1000 characters.", "disabled": false }, { "key": "slugs", "value": "bitcoin,ethereum", "description": "Filter to specific coin slugs (CSV, up to 100 selectors combined). Must not be greater than 2000 characters.", "disabled": false }, { "key": "symbols", "value": "BTC,ETH", "description": "Filter to specific coin symbols (CSV, case-insensitive, up to 100 selectors combined). Must not be greater than 1000 characters.", "disabled": false }, { "key": "sort", "value": "-marketcap", "description": "Comma-separated sort fields; prefix with - for descending. Sortable: marketcap, rank, price, volume_24h, change_24h, change_7d. Must not be greater than 100 characters.", "disabled": false }, { "key": "interval", "value": "24h", "description": "Movers window for \/coins\/gainers and \/coins\/losers only: 24h or 7d.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/coins\/gainers?page=1&per_page=50&type=coin&status=active&search=bitcoin&min_price=0.5&max_price=100000&min_marketcap=1000000&max_marketcap=5000000000000&min_volume=1000000&max_volume=100000000000&ids=38%2C39&slugs=bitcoin%2Cethereum&symbols=BTC%2CETH&sort=-marketcap&interval=24h" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Biggest positive movers over the `interval` window (24h default, or 7d). Same row\nshape and pagination envelope as `List coins`." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":38,\"slug\":\"bitcoin\",\"name\":\"Bitcoin\",\"symbol\":\"BTC\",\"rank\":1,\"price\":\"63520.780763913\",\"marketcap\":1264646594448.5,\"volume_24h\":5345161962,\"change_24h\":1.35,\"change_7d\":4.98,\"change_rank_24h\":0,\"change_rank_7d\":0,\"circulating_supply\":\"19909179\",\"logo\":\"https:\/\/bitculator.com\/storage\/media\/logo\/bitcoin.png\",\"listed_at\":\"2025-03-15T17:00:43+00:00\",\"last_updated\":\"2026-06-27T10:34:17+00:00\"}],\"links\":{\"first\":\"https:\/\/bitculator.com\/api\/v1\/coins\/gainers?page=1\",\"last\":\"https:\/\/bitculator.com\/api\/v1\/coins\/gainers?page=2\",\"prev\":null,\"next\":\"https:\/\/bitculator.com\/api\/v1\/coins\/gainers?page=2\"},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":2,\"per_page\":50,\"to\":50,\"total\":89}}", "name": "" } ] }, { "name": "Top losers", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/coins\/losers", "query": [ { "key": "page", "value": "1", "description": "Page number (1-based). Must be at least 1.", "disabled": false }, { "key": "per_page", "value": "50", "description": "Rows per page. The cap is plan-based (Free 100, Starter\/Pro 250); exceeding it returns 422 rather than clamping. Must be at least 1. Must not be greater than 100.", "disabled": false }, { "key": "type", "value": "coin", "description": "Restrict to a single asset type: coin or token.", "disabled": false }, { "key": "status", "value": "active", "description": "Listing status: active, delisted, untracked, progressing, awaiting or preparing. Defaults to all public statuses.", "disabled": false }, { "key": "search", "value": "bitcoin", "description": "Free-text match on name or symbol. Must not be greater than 100 characters.", "disabled": false }, { "key": "min_price", "value": "0.5", "description": "Only coins priced at or above this USD value. Must be at least 0.", "disabled": false }, { "key": "max_price", "value": "100000", "description": "Only coins priced at or below this USD value. Must be at least 0.", "disabled": false }, { "key": "min_marketcap", "value": "1000000", "description": "Only coins with a USD marketcap at or above this value. Must be at least 0.", "disabled": false }, { "key": "max_marketcap", "value": "5000000000000", "description": "Only coins with a USD marketcap at or below this value. Must be at least 0.", "disabled": false }, { "key": "min_volume", "value": "1000000", "description": "Only coins with 24h USD volume at or above this value. Must be at least 0.", "disabled": false }, { "key": "max_volume", "value": "100000000000", "description": "Only coins with 24h USD volume at or below this value. Must be at least 0.", "disabled": false }, { "key": "ids", "value": "38,39", "description": "Filter to specific coin ids (CSV, up to 100 selectors combined with slugs\/symbols). Must not be greater than 1000 characters.", "disabled": false }, { "key": "slugs", "value": "bitcoin,ethereum", "description": "Filter to specific coin slugs (CSV, up to 100 selectors combined). Must not be greater than 2000 characters.", "disabled": false }, { "key": "symbols", "value": "BTC,ETH", "description": "Filter to specific coin symbols (CSV, case-insensitive, up to 100 selectors combined). Must not be greater than 1000 characters.", "disabled": false }, { "key": "sort", "value": "-marketcap", "description": "Comma-separated sort fields; prefix with - for descending. Sortable: marketcap, rank, price, volume_24h, change_24h, change_7d. Must not be greater than 100 characters.", "disabled": false }, { "key": "interval", "value": "24h", "description": "Movers window for \/coins\/gainers and \/coins\/losers only: 24h or 7d.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/coins\/losers?page=1&per_page=50&type=coin&status=active&search=bitcoin&min_price=0.5&max_price=100000&min_marketcap=1000000&max_marketcap=5000000000000&min_volume=1000000&max_volume=100000000000&ids=38%2C39&slugs=bitcoin%2Cethereum&symbols=BTC%2CETH&sort=-marketcap&interval=24h" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Biggest negative movers over the `interval` window (24h default, or 7d). Same row\nshape and pagination envelope as `List coins`." }, "response": [] }, { "name": "Trending coins", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/coins\/trending", "query": [ { "key": "limit", "value": "10", "description": "How many trending coins to return (1\u201320, default 10).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/coins\/trending?limit=10" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "The most-viewed coins right now, ranked by view `score`. A compact projection\n(no pagination): id, slug, name, symbol, rank, price (decimal string), marketcap,\nlogo and score." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":38,\"slug\":\"bitcoin\",\"name\":\"Bitcoin\",\"symbol\":\"BTC\",\"rank\":1,\"price\":\"63520.780763913\",\"marketcap\":1264646594448.5,\"logo\":\"https:\/\/bitculator.com\/storage\/media\/logo\/bitcoin.png\",\"score\":2}]}", "name": "" } ] }, { "name": "Get coin detail", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/coins\/:slug", "query": [ { "key": "locale", "value": "en", "description": "Content language for the description (falls back to English).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/coins\/:slug?locale=en", "variable": [ { "id": "slug", "key": "slug", "value": "bitcoin", "description": "The coin slug." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Full single-coin profile. Beyond the list fields it adds: `supply`\n(circulating\/total\/max), `today` OHLC, `all_time_high` \/ `all_time_low` (price,\ndate and percent_from the current price), `fully_diluted_valuation`, market\n`counts` (exchanges\/pairs\/tickers\/wallets), `decimals`, `genesis_date`, official\n`links` (typed url list), token `contracts`, and a localized HTML `description`\n(falls back to English when the requested locale is missing). All price\/supply\nfields are decimal strings." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":38,\"slug\":\"bitcoin\",\"name\":\"Bitcoin\",\"symbol\":\"BTC\",\"type\":\"coin\",\"rank\":1,\"price\":\"63520.780763913\",\"marketcap\":1264646594448.5,\"fully_diluted_valuation\":1333936396042.17,\"volume_24h\":5345161962,\"change_24h\":1.35,\"change_7d\":4.98,\"change_rank_24h\":0,\"change_rank_7d\":0,\"supply\":{\"circulating\":\"19909179\",\"total\":\"19970852\",\"max\":\"21000000\"},\"today\":{\"open\":\"63408.100996475\",\"high\":\"63640.608639825\",\"low\":\"62798.732107749\",\"close\":\"63520.780763913\"},\"all_time_high\":{\"price\":\"125881.21309073\",\"date\":\"2025-10-06\",\"percent_from\":-49.54},\"all_time_low\":{\"price\":\"0.099\",\"date\":\"2010-10-12\",\"percent_from\":64162304.81},\"counts\":{\"exchanges\":11,\"pairs\":92,\"tickers\":211,\"wallets\":206},\"decimals\":8,\"genesis_date\":\"2009-01-03\",\"description\":\"

Bitcoin is a decentralized digital currency\u2026<\/p>\",\"links\":[{\"type\":\"website\",\"url\":\"https:\/\/bitcoin.org\/en\/\"},{\"type\":\"whitepaper\",\"url\":\"https:\/\/bitcoin.org\/bitcoin.pdf\"}],\"contracts\":[],\"logo\":\"https:\/\/bitculator.com\/storage\/media\/logo\/bitcoin.png\",\"last_updated\":\"2026-06-27T10:34:17+00:00\"}}", "name": "" }, { "header": [], "code": 404, "body": "{\"error\":{\"code\":\"not_found\",\"message\":\"Coin not found.\"}}", "name": "" } ] }, { "name": "Candle history", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/coins\/:slug\/history", "query": [ { "key": "interval", "value": "daily", "description": "minutely, half-hourly, hourly or daily (default daily).", "disabled": false }, { "key": "start", "value": "2026-06-01", "description": "ISO date\/time lower bound.", "disabled": false }, { "key": "end", "value": "2026-06-30", "description": "ISO date\/time upper bound (a date-only value means through that day).", "disabled": false }, { "key": "limit", "value": "30", "description": "Max rows (1\u20132000, default 1000).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/coins\/:slug\/history?interval=daily&start=2026-06-01&end=2026-06-30&limit=30", "variable": [ { "id": "slug", "key": "slug", "value": "bitcoin", "description": "The coin slug." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Per-coin OHLC + volume + marketcap time series. Pick `interval`: minutely,\nhalf-hourly, hourly or daily. Retention is a hard property of the rollup\npipeline \u2014 minutely 8 days, half-hourly 3 months, hourly 6 months, daily forever;\nrequests beyond a window return what exists. When a `limit` is set you get the\nMOST RECENT N rows in the window, emitted oldest-first. Prices are decimal\nstrings." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"time\":\"2026-06-14T23:01:01+00:00\",\"price\":\"65481.259006434\",\"open\":\"64193.294621057\",\"high\":\"65513.599862059\",\"low\":\"63528.138075558\",\"close\":\"65481.259006434\",\"volume_24h\":3795657715,\"marketcap\":1303678106704.5}],\"meta\":{\"coin\":\"bitcoin\",\"interval\":\"daily\",\"count\":1,\"retention\":\"full history\"}}", "name": "" }, { "header": [], "code": 404, "body": "{\"error\":{\"code\":\"not_found\",\"message\":\"Coin not found.\"}}", "name": "" } ] }, { "name": "Marketcap history", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/coins\/:slug\/marketcap-history", "query": [ { "key": "interval", "value": "daily", "description": "minutely, half-hourly, hourly or daily (default daily).", "disabled": false }, { "key": "start", "value": "2026-06-01", "description": "ISO date\/time lower bound.", "disabled": false }, { "key": "end", "value": "2026-06-30", "description": "ISO date\/time upper bound.", "disabled": false }, { "key": "limit", "value": "30", "description": "Max rows (1\u20132000, default 1000).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/coins\/:slug\/marketcap-history?interval=daily&start=2026-06-01&end=2026-06-30&limit=30", "variable": [ { "id": "slug", "key": "slug", "value": "bitcoin", "description": "The coin slug." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "The same per-coin rollups as `Candle history`, projected to `{time, marketcap}`\nonly. Same `interval` choices and retention windows (minutely 8 days,\nhalf-hourly 3 months, hourly 6 months, daily forever), most-recent-N when a\n`limit` is set." }, "response": [] }, { "name": "Coin sparkline", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/coins\/:slug\/sparkline", "query": [ { "key": "period", "value": "7d", "description": "24h, 7d, 30d, 60d, 90d, 180d or 365d (default 7d).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/coins\/:slug\/sparkline?period=7d", "variable": [ { "id": "slug", "key": "slug", "value": "bitcoin", "description": "The coin slug." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "A compact price series for the coin over the chosen `period`, for drawing\nsparklines." }, "response": [] } ] }, { "name": "Prices", "description": "\nThe lightweight price hot path \u2014 current price, marketcap, 24h volume and recent\nchanges for a requested set of coins. `\/prices` requires a selector (ids, slugs or\nsymbols); `\/prices\/{slug}` targets one coin. Optionally `convert` into a fiat\ncurrency (crypto prices refresh ~every minute, fiat FX ~twice daily). Prices and\nmarketcap are decimal strings.", "item": [ { "name": "Get prices", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/prices", "query": [ { "key": "ids", "value": "38,39", "description": "Coin ids to price (CSV). At least one of ids, slugs or symbols is required; the three lists cap at 100 selectors combined. This field is required when none of slugs and symbols are present. Must not be greater than 1000 characters.", "disabled": false }, { "key": "slugs", "value": "bitcoin,ethereum", "description": "Coin slugs to price (CSV). At least one of ids, slugs or symbols is required. This field is required when none of ids and symbols are present. Must not be greater than 2000 characters.", "disabled": false }, { "key": "symbols", "value": "BTC,ETH", "description": "Coin symbols to price (CSV, case-insensitive). At least one of ids, slugs or symbols is required. This field is required when none of ids and slugs are present. Must not be greater than 1000 characters.", "disabled": false }, { "key": "convert", "value": "EUR", "description": "Convert prices\/marketcap into an active fiat currency by symbol (default USD). FX rates refresh ~twice daily.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/prices?ids=38%2C39&slugs=bitcoin%2Cethereum&symbols=BTC%2CETH&convert=EUR" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Prices for a requested set of coins. Pass at least one selector \u2014 `ids`, `slugs`\nor `symbols` (up to 100 combined). `meta.currency` echoes the conversion target\n(USD unless `convert` is set)." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":38,\"slug\":\"bitcoin\",\"symbol\":\"BTC\",\"name\":\"Bitcoin\",\"rank\":1,\"price\":\"63520.780763913\",\"marketcap\":1264646594448.5,\"volume_24h\":5345161962,\"change_24h\":1.35,\"change_7d\":4.98,\"change_rank_24h\":0,\"change_rank_7d\":0,\"last_updated\":\"2026-06-27T10:34:17+00:00\"},{\"id\":39,\"slug\":\"ethereum\",\"symbol\":\"ETH\",\"name\":\"Ethereum\",\"rank\":2,\"price\":\"1672.4623100248\",\"marketcap\":203243220990.49,\"volume_24h\":69585141532,\"change_24h\":1.42,\"change_7d\":7.56,\"change_rank_24h\":0,\"change_rank_7d\":0,\"last_updated\":\"2026-06-12T09:32:14+00:00\"}],\"meta\":{\"currency\":\"USD\",\"count\":2}}", "name": "" }, { "header": [], "code": 422, "body": "{\"error\":{\"code\":\"validation\",\"message\":\"The request parameters are invalid.\",\"details\":{\"errors\":{\"ids\":[\"Pass at least one selector: ids, slugs or symbols.\"]}}}}", "name": "" } ] }, { "name": "Get a coin price", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/prices\/:slug", "query": [ { "key": "convert", "value": "EUR", "description": "Active fiat currency symbol to price in (default USD).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/prices\/:slug?convert=EUR", "variable": [ { "id": "slug", "key": "slug", "value": "bitcoin", "description": "The coin slug." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Single-coin price snapshot. Optionally `convert` into an active fiat currency by\nsymbol (default USD)." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":38,\"slug\":\"bitcoin\",\"symbol\":\"BTC\",\"name\":\"Bitcoin\",\"rank\":1,\"price\":\"63520.780763913\",\"marketcap\":1264646594448.5,\"volume_24h\":5345161962,\"change_24h\":1.35,\"change_7d\":4.98,\"change_rank_24h\":0,\"change_rank_7d\":0,\"last_updated\":\"2026-06-27T10:34:17+00:00\"},\"meta\":{\"currency\":\"USD\",\"count\":1}}", "name": "" }, { "header": [], "code": 404, "body": "{\"error\":{\"code\":\"not_found\",\"message\":\"Coin not found.\"}}", "name": "" } ] }, { "name": "Historical price", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/historical-price", "query": [ { "key": "slug", "value": "bitcoin", "description": "The coin's slug identifier.", "disabled": false }, { "key": "date", "value": "2021-04-14", "description": "date The lookup date (after 2008-12-31, not in the future).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/historical-price?slug=bitcoin&date=2021-04-14" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "The coin's USD price on a given date, read from the daily history (exact day,\n\u00b13-day fallback \u2014 the same resolver the portfolio uses). Crypto only: fiat rows\nhave no daily history." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"slug\":\"bitcoin\",\"symbol\":\"BTC\",\"date\":\"2021-04-14\",\"price\":\"63109.7\",\"currency\":\"USD\"}}", "name": "" } ] } ] }, { "name": "Markets", "description": "\nTickers (per-exchange markets) and pairs (venue-aggregated markets), plus a coin's\nmarkets and raw per-exchange trading symbols. All of it is snapshot data \u2014 no\nper-ticker\/pair history exists. USD volumes are numbers; prices are decimal strings.", "item": [ { "name": "Coin markets", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/coins\/:slug\/markets", "query": [ { "key": "page", "value": "1", "description": "Page number (1-based). Must be at least 1.", "disabled": false }, { "key": "per_page", "value": "50", "description": "Rows per page. The cap is plan-based (Free 100, Starter\/Pro 250); exceeding it returns 422 rather than clamping. Must be at least 1. Must not be greater than 100.", "disabled": false }, { "key": "exchange", "value": "binance-exchange", "description": "Restrict to a single exchange by slug (omit on the per-exchange listing, which is already scoped). Must match the regex \/^[a-z0-9\\-]{1,120}$\/.", "disabled": false }, { "key": "pair", "value": "1", "description": "Restrict to a single pair by id. Must be at least 1.", "disabled": false }, { "key": "instrument", "value": "spot", "description": "Instrument type: future, option, swap, spot or margin (plurals accepted).", "disabled": false }, { "key": "search", "value": "BTC", "description": "Free-text match on the ticker symbol. Must not be greater than 50 characters.", "disabled": false }, { "key": "min_volume", "value": "1000000", "description": "Only tickers with 24h USD volume at or above this value. Must be at least 0.", "disabled": false }, { "key": "max_volume", "value": "100000000000", "description": "Only tickers with 24h USD volume at or below this value. Must be at least 0.", "disabled": false }, { "key": "min_change", "value": "-50", "description": "Only tickers with a 24h percentage change at or above this value.", "disabled": false }, { "key": "max_change", "value": "50", "description": "Only tickers with a 24h percentage change at or below this value.", "disabled": false }, { "key": "sort", "value": "-volume_usd", "description": "A single sort field (prefix with - for descending). Sortable: volume_usd, change_24h, price_usd, updated. Defaults to -volume_usd. Must not be greater than 100 characters.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/coins\/:slug\/markets?page=1&per_page=50&exchange=binance-exchange&pair=1&instrument=spot&search=BTC&min_volume=1000000&max_volume=100000000000&min_change=-50&max_change=50&sort=-volume_usd", "variable": [ { "id": "slug", "key": "slug", "value": "bitcoin", "description": "The coin slug." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "All markets for a coin \u2014 the tickers whose pair has the coin as base OR quote.\nSame row shape and filters as `List tickers`." }, "response": [] }, { "name": "Coin trading symbols", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/coins\/:slug\/symbols", "query": [], "raw": "{{baseUrl}}\/api\/v1\/coins\/:slug\/symbols", "variable": [ { "id": "slug", "key": "slug", "value": "bitcoin", "description": "The coin slug." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "The coin's raw per-exchange trading symbols \u2014 sparsely populated reference data\n(coverage is best-effort)." }, "response": [] }, { "name": "List tickers", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/tickers", "query": [ { "key": "page", "value": "1", "description": "Page number (1-based). Must be at least 1.", "disabled": false }, { "key": "per_page", "value": "50", "description": "Rows per page. The cap is plan-based (Free 100, Starter\/Pro 250); exceeding it returns 422 rather than clamping. Must be at least 1. Must not be greater than 100.", "disabled": false }, { "key": "exchange", "value": "binance-exchange", "description": "Restrict to a single exchange by slug (omit on the per-exchange listing, which is already scoped). Must match the regex \/^[a-z0-9\\-]{1,120}$\/.", "disabled": false }, { "key": "pair", "value": "1", "description": "Restrict to a single pair by id. Must be at least 1.", "disabled": false }, { "key": "instrument", "value": "spot", "description": "Instrument type: future, option, swap, spot or margin (plurals accepted).", "disabled": false }, { "key": "search", "value": "BTC", "description": "Free-text match on the ticker symbol. Must not be greater than 50 characters.", "disabled": false }, { "key": "min_volume", "value": "1000000", "description": "Only tickers with 24h USD volume at or above this value. Must be at least 0.", "disabled": false }, { "key": "max_volume", "value": "100000000000", "description": "Only tickers with 24h USD volume at or below this value. Must be at least 0.", "disabled": false }, { "key": "min_change", "value": "-50", "description": "Only tickers with a 24h percentage change at or above this value.", "disabled": false }, { "key": "max_change", "value": "50", "description": "Only tickers with a 24h percentage change at or below this value.", "disabled": false }, { "key": "sort", "value": "-volume_usd", "description": "A single sort field (prefix with - for descending). Sortable: volume_usd, change_24h, price_usd, updated. Defaults to -volume_usd. Must not be greater than 100 characters.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/tickers?page=1&per_page=50&exchange=binance-exchange&pair=1&instrument=spot&search=BTC&min_volume=1000000&max_volume=100000000000&min_change=-50&max_change=50&sort=-volume_usd" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Individual per-exchange markets (tickers), paginated. Filter by exchange, pair,\ninstrument and volume\/change ranges. USD volumes are numbers; prices are decimal\nstrings." }, "response": [] }, { "name": "List pairs", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/pairs", "query": [ { "key": "page", "value": "1", "description": "Page number (1-based). Must be at least 1.", "disabled": false }, { "key": "per_page", "value": "50", "description": "Rows per page. The cap is plan-based (Free 100, Starter\/Pro 250); exceeding it returns 422 rather than clamping. Must be at least 1. Must not be greater than 100.", "disabled": false }, { "key": "search", "value": "BTC", "description": "Free-text match on the pair symbol. Must not be greater than 50 characters.", "disabled": false }, { "key": "coin", "value": "bitcoin", "description": "Restrict to pairs where this coin slug is the base or quote asset. Must match the regex \/^[a-z0-9\\-]{1,120}$\/.", "disabled": false }, { "key": "min_volume", "value": "1000000", "description": "Only pairs with 24h USD volume at or above this value. Must be at least 0.", "disabled": false }, { "key": "max_volume", "value": "100000000000", "description": "Only pairs with 24h USD volume at or below this value. Must be at least 0.", "disabled": false }, { "key": "sort", "value": "-volume_usd", "description": "Sort field: volume_usd or updated (prefix with - for descending). Defaults to -volume_usd.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/pairs?page=1&per_page=50&search=BTC&coin=bitcoin&min_volume=1000000&max_volume=100000000000&sort=-volume_usd" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Venue-aggregated trading pairs, ranked by 24h USD volume. Filter by a coin slug\n(base or quote) and volume range." }, "response": [] }, { "name": "Get pair detail", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/pairs\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/pairs\/:id", "variable": [ { "id": "id", "key": "id", "value": 1, "description": "The pair id." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "One pair plus every exchange ticker listing it, ordered by volume." }, "response": [ { "header": [], "code": 404, "body": "{\"error\":{\"code\":\"not_found\",\"message\":\"Pair not found.\"}}", "name": "" } ] } ] }, { "name": "Exchanges", "description": "\nExchange rankings, detail, trust scores, time series and per-exchange market\/coin\nlistings. Volumes are USD. There is no CEX\/DEX column \u2014 `type` is derived from the\nexchange taxonomy, so it can be \"cex\", \"dex\" or null.", "item": [ { "name": "List exchanges", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/exchanges", "query": [ { "key": "page", "value": "1", "description": "Page number (1-based). Must be at least 1.", "disabled": false }, { "key": "per_page", "value": "50", "description": "Rows per page. The cap is plan-based (Free 100, Starter\/Pro 250); exceeding it returns 422 rather than clamping. Must be at least 1. Must not be greater than 100.", "disabled": false }, { "key": "type", "value": "cex", "description": "Restrict to a venue type: cex or dex (resolved via the exchange taxonomy).", "disabled": false }, { "key": "search", "value": "binance", "description": "Free-text match on exchange name. Must not be greater than 100 characters.", "disabled": false }, { "key": "min_pairs", "value": "100", "description": "Only exchanges listing at least this many pairs. Must be at least 0.", "disabled": false }, { "key": "max_pairs", "value": "2000", "description": "Only exchanges listing at most this many pairs. Must be at least 0.", "disabled": false }, { "key": "min_assets", "value": "50", "description": "Only exchanges listing at least this many assets. Must be at least 0.", "disabled": false }, { "key": "max_assets", "value": "1000", "description": "Only exchanges listing at most this many assets. Must be at least 0.", "disabled": false }, { "key": "min_volume", "value": "1000000", "description": "Only exchanges with 24h USD volume at or above this value. Must be at least 0.", "disabled": false }, { "key": "max_volume", "value": "100000000000", "description": "Only exchanges with 24h USD volume at or below this value. Must be at least 0.", "disabled": false }, { "key": "ids", "value": "1,12", "description": "Filter to specific exchange ids (CSV, up to 100). Must not be greater than 1000 characters.", "disabled": false }, { "key": "slugs", "value": "binance-exchange,gateio", "description": "Filter to specific exchange slugs (CSV, up to 100). Must not be greater than 2000 characters.", "disabled": false }, { "key": "sort", "value": "-volume", "description": "Comma-separated sort fields; prefix with - for descending. Sortable: volume, rank, volume_dominance, change_24h, change_7d, pairs, assets. Must not be greater than 100 characters.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/exchanges?page=1&per_page=50&type=cex&search=binance&min_pairs=100&max_pairs=2000&min_assets=50&max_assets=1000&min_volume=1000000&max_volume=100000000000&ids=1%2C12&slugs=binance-exchange%2Cgateio&sort=-volume" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Ranked exchanges with 24h volume, dominance, pair\/asset counts and recent\nchanges. Paginated with Laravel's `links` + `meta` envelope." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":1,\"slug\":\"binance-exchange\",\"name\":\"Binance\",\"rank\":1,\"volume_24h\":6152385798,\"volume_dominance\":36.98,\"change_24h\":200.09,\"change_7d\":22.87,\"change_rank_24h\":0,\"change_rank_7d\":0,\"pairs\":1115,\"assets\":100,\"logo\":\"https:\/\/bitculator.com\/storage\/media\/logo\/binance.png\",\"last_updated\":\"2026-06-15T16:59:21+00:00\"}],\"links\":{\"first\":\"https:\/\/bitculator.com\/api\/v1\/exchanges?page=1\",\"last\":\"https:\/\/bitculator.com\/api\/v1\/exchanges?page=1\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"per_page\":50,\"to\":10,\"total\":10}}", "name": "" } ] }, { "name": "Get exchange detail", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/exchanges\/:slug", "query": [], "raw": "{{baseUrl}}\/api\/v1\/exchanges\/:slug", "variable": [ { "id": "slug", "key": "slug", "value": "binance-exchange", "description": "The exchange slug." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Full single-exchange profile: ranking, volume\/dominance, pair and asset counts,\n`established` date, `location`, referral `website`, and the derived `type`\n(cex\/dex\/null)." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":1,\"slug\":\"binance-exchange\",\"name\":\"Binance\",\"type\":\"cex\",\"rank\":1,\"volume_24h\":6152385798,\"volume_dominance\":36.98,\"change_24h\":200.09,\"change_7d\":22.87,\"change_rank_24h\":0,\"change_rank_7d\":0,\"pairs\":1115,\"assets\":100,\"established\":\"2017-07-14\",\"location\":\"Cayman Islands\",\"website\":\"https:\/\/accounts.binance.com\/register\",\"logo\":\"https:\/\/bitculator.com\/storage\/media\/logo\/binance.png\",\"last_updated\":\"2026-06-15T16:59:21+00:00\"}}", "name": "" }, { "header": [], "code": 404, "body": "{\"error\":{\"code\":\"not_found\",\"message\":\"Exchange not found.\"}}", "name": "" } ] }, { "name": "Get exchange trust score", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/exchanges\/:slug\/trust-score", "query": [], "raw": "{{baseUrl}}\/api\/v1\/exchanges\/:slug\/trust-score", "variable": [ { "id": "slug", "key": "slug", "value": "binance-exchange", "description": "The exchange slug." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "An aggregate 0\u201310 trust `score` plus its 13-factor `breakdown` (rank, volume,\nage, volume_trend, stability, rank_stability, ticker_health, pairs, community,\nassets, dominance, market_breadth, transparency). Computed per exchange and\ncached 24h." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"exchange\":\"binance-exchange\",\"score\":8.3,\"breakdown\":{\"rank\":10,\"volume\":10,\"age\":10,\"volume_trend\":7,\"stability\":3,\"rank_stability\":10,\"ticker_health\":8.6,\"pairs\":9.6,\"community\":6,\"assets\":6.6,\"dominance\":9.4,\"market_breadth\":8,\"transparency\":8.5}}}", "name": "" }, { "header": [], "code": 404, "body": "{\"error\":{\"code\":\"not_found\",\"message\":\"Exchange not found.\"}}", "name": "" } ] }, { "name": "Exchange history", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/exchanges\/:slug\/history", "query": [ { "key": "interval", "value": "daily", "description": "minutely, hourly or daily (default daily).", "disabled": false }, { "key": "start", "value": "2026-06-01", "description": "ISO date\/time lower bound.", "disabled": false }, { "key": "end", "value": "2026-06-30", "description": "ISO date\/time upper bound (a date-only value means through that day).", "disabled": false }, { "key": "limit", "value": "30", "description": "Max rows (1\u20132000, default 1000).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/exchanges\/:slug\/history?interval=daily&start=2026-06-01&end=2026-06-30&limit=30", "variable": [ { "id": "slug", "key": "slug", "value": "binance-exchange", "description": "The exchange slug." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Volume \/ dominance \/ pairs \/ assets time series (the exchange rollups carry no\nOHLC). Pick `interval`: minutely, hourly or daily. Retention is a hard property\nof the rollup pipeline \u2014 minutely 8 days, hourly 6 months, daily forever; when a\n`limit` is set you get the most-recent N rows in the window, oldest-first." }, "response": [] }, { "name": "Exchange sparkline", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/exchanges\/:slug\/sparkline", "query": [ { "key": "period", "value": "7d", "description": "One of `24h`, `7d` (default), `30d`, `60d`, `90d`, `180d`, `365d`.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/exchanges\/:slug\/sparkline?period=7d", "variable": [ { "id": "slug", "key": "slug", "value": "binance-exchange", "description": "The exchange slug." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "The exchange's volume sparkline series for a period (defaults to 7d) \u2014 the same\nseries the web's exchange rows render." }, "response": [] }, { "name": "Exchange markets", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/exchanges\/:slug\/tickers", "query": [ { "key": "page", "value": "1", "description": "Page number (1-based). Must be at least 1.", "disabled": false }, { "key": "per_page", "value": "50", "description": "Rows per page. The cap is plan-based (Free 100, Starter\/Pro 250); exceeding it returns 422 rather than clamping. Must be at least 1. Must not be greater than 100.", "disabled": false }, { "key": "exchange", "value": "binance-exchange", "description": "Restrict to a single exchange by slug (omit on the per-exchange listing, which is already scoped). Must match the regex \/^[a-z0-9\\-]{1,120}$\/.", "disabled": false }, { "key": "pair", "value": "1", "description": "Restrict to a single pair by id. Must be at least 1.", "disabled": false }, { "key": "instrument", "value": "spot", "description": "Instrument type: future, option, swap, spot or margin (plurals accepted).", "disabled": false }, { "key": "search", "value": "BTC", "description": "Free-text match on the ticker symbol. Must not be greater than 50 characters.", "disabled": false }, { "key": "min_volume", "value": "1000000", "description": "Only tickers with 24h USD volume at or above this value. Must be at least 0.", "disabled": false }, { "key": "max_volume", "value": "100000000000", "description": "Only tickers with 24h USD volume at or below this value. Must be at least 0.", "disabled": false }, { "key": "min_change", "value": "-50", "description": "Only tickers with a 24h percentage change at or above this value.", "disabled": false }, { "key": "max_change", "value": "50", "description": "Only tickers with a 24h percentage change at or below this value.", "disabled": false }, { "key": "sort", "value": "-volume_usd", "description": "A single sort field (prefix with - for descending). Sortable: volume_usd, change_24h, price_usd, updated. Defaults to -volume_usd. Must not be greater than 100 characters.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/exchanges\/:slug\/tickers?page=1&per_page=50&exchange=binance-exchange&pair=1&instrument=spot&search=BTC&min_volume=1000000&max_volume=100000000000&min_change=-50&max_change=50&sort=-volume_usd", "variable": [ { "id": "slug", "key": "slug", "value": "binance-exchange", "description": "The exchange slug." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "The exchange's ticker listings (its markets), paginated. Already scoped to the\nexchange \u2014 do not pass an `exchange` parameter here." }, "response": [] }, { "name": "Exchange coins", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/exchanges\/:slug\/assets", "query": [ { "key": "page", "value": "1", "description": "Page number (1-based). Must be at least 1.", "disabled": false }, { "key": "per_page", "value": "50", "description": "Rows per page. The cap is plan-based (Free 100, Starter\/Pro 250); exceeding it returns 422 rather than clamping. Must be at least 1. Must not be greater than 100.", "disabled": false }, { "key": "type", "value": "coin", "description": "Restrict to a single asset type: coin or token.", "disabled": false }, { "key": "status", "value": "active", "description": "Listing status: active, delisted, untracked, progressing, awaiting or preparing. Defaults to all public statuses.", "disabled": false }, { "key": "search", "value": "bitcoin", "description": "Free-text match on name or symbol. Must not be greater than 100 characters.", "disabled": false }, { "key": "min_price", "value": "0.5", "description": "Only coins priced at or above this USD value. Must be at least 0.", "disabled": false }, { "key": "max_price", "value": "100000", "description": "Only coins priced at or below this USD value. Must be at least 0.", "disabled": false }, { "key": "min_marketcap", "value": "1000000", "description": "Only coins with a USD marketcap at or above this value. Must be at least 0.", "disabled": false }, { "key": "max_marketcap", "value": "5000000000000", "description": "Only coins with a USD marketcap at or below this value. Must be at least 0.", "disabled": false }, { "key": "min_volume", "value": "1000000", "description": "Only coins with 24h USD volume at or above this value. Must be at least 0.", "disabled": false }, { "key": "max_volume", "value": "100000000000", "description": "Only coins with 24h USD volume at or below this value. Must be at least 0.", "disabled": false }, { "key": "ids", "value": "38,39", "description": "Filter to specific coin ids (CSV, up to 100 selectors combined with slugs\/symbols). Must not be greater than 1000 characters.", "disabled": false }, { "key": "slugs", "value": "bitcoin,ethereum", "description": "Filter to specific coin slugs (CSV, up to 100 selectors combined). Must not be greater than 2000 characters.", "disabled": false }, { "key": "symbols", "value": "BTC,ETH", "description": "Filter to specific coin symbols (CSV, case-insensitive, up to 100 selectors combined). Must not be greater than 1000 characters.", "disabled": false }, { "key": "sort", "value": "-marketcap", "description": "Comma-separated sort fields; prefix with - for descending. Sortable: marketcap, rank, price, volume_24h, change_24h, change_7d. Must not be greater than 100 characters.", "disabled": false }, { "key": "interval", "value": "24h", "description": "Movers window for \/coins\/gainers and \/coins\/losers only: 24h or 7d.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/exchanges\/:slug\/assets?page=1&per_page=50&type=coin&status=active&search=bitcoin&min_price=0.5&max_price=100000&min_marketcap=1000000&max_marketcap=5000000000000&min_volume=1000000&max_volume=100000000000&ids=38%2C39&slugs=bitcoin%2Cethereum&symbols=BTC%2CETH&sort=-marketcap&interval=24h", "variable": [ { "id": "slug", "key": "slug", "value": "binance-exchange", "description": "The exchange slug." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Coins listed on the exchange, returned in the same shape as `List coins` and\naccepting the same filters\/sort." }, "response": [] } ] }, { "name": "Wallets", "description": "\nCrypto wallet reviews \u2014 review `score`, supported-asset count, pros\/cons counts,\nprice model and release date, plus a grouped tag taxonomy on detail\/compare\nresponses. `meta.top_score` is the highest score across all wallets (use it to\nnormalize scores into a 0\u20131 range).", "item": [ { "name": "List wallets", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/wallets", "query": [ { "key": "page", "value": "1", "description": "Page number (1-based). Must be at least 1.", "disabled": false }, { "key": "per_page", "value": "50", "description": "Rows per page. The cap is plan-based (Free 100, Starter\/Pro 250); exceeding it returns 422 rather than clamping. Must be at least 1. Must not be greater than 100.", "disabled": false }, { "key": "search", "value": "ledger", "description": "Free-text match on wallet name. Must not be greater than 100 characters.", "disabled": false }, { "key": "min_score", "value": "50", "description": "Only wallets with a review score at or above this value. Must be at least 0.", "disabled": false }, { "key": "max_score", "value": "214", "description": "Only wallets with a review score at or below this value. Must be at least 0.", "disabled": false }, { "key": "tags", "value": "12,34", "description": "Filter by tag taxonomy: comma-separated category-group ids (the same ids the web facet filters submit). Must not be greater than 1000 characters.", "disabled": false }, { "key": "ids", "value": "175,317", "description": "Filter to specific wallet ids (CSV, up to 100). Must not be greater than 1000 characters.", "disabled": false }, { "key": "slugs", "value": "frostsnap,coin98-fusion-card", "description": "Filter to specific wallet slugs (CSV, up to 100). Must not be greater than 2000 characters.", "disabled": false }, { "key": "sort", "value": "-score", "description": "Comma-separated sort fields; prefix with - for descending. Sortable: score, released_at, assets, pros, cons. Must not be greater than 100 characters.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/wallets?page=1&per_page=50&search=ledger&min_score=50&max_score=214&tags=12%2C34&ids=175%2C317&slugs=frostsnap%2Ccoin98-fusion-card&sort=-score" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Reviewed wallets with score, asset count, pros\/cons counts, price model, status\nand release date. Paginated with Laravel's `links` + `meta` envelope, plus\n`meta.top_score`." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":317,\"slug\":\"frostsnap\",\"name\":\"Frostsnap\",\"score\":125,\"assets\":1,\"pros\":18,\"cons\":0,\"price_model\":\"paid\",\"status\":\"Active\",\"released_at\":null,\"logo\":\"https:\/\/bitculator.com\/storage\/media\/logo\/frostsnap.png\"}],\"links\":{\"first\":\"https:\/\/bitculator.com\/api\/v1\/wallets?page=1\",\"last\":\"https:\/\/bitculator.com\/api\/v1\/wallets?page=7\",\"prev\":null,\"next\":\"https:\/\/bitculator.com\/api\/v1\/wallets?page=2\"},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":7,\"per_page\":50,\"to\":50,\"total\":321,\"top_score\":214}}", "name": "" } ] }, { "name": "Wallet release timeline", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/wallets\/timeline", "query": [ { "key": "page", "value": "1", "description": "Page number (1-based). Must be at least 1.", "disabled": false }, { "key": "per_page", "value": "50", "description": "Rows per page. The cap is plan-based (Free 100, Starter\/Pro 250); exceeding it returns 422 rather than clamping. Must be at least 1. Must not be greater than 100.", "disabled": false }, { "key": "search", "value": "ledger", "description": "Free-text match on wallet name. Must not be greater than 100 characters.", "disabled": false }, { "key": "min_score", "value": "50", "description": "Only wallets with a review score at or above this value. Must be at least 0.", "disabled": false }, { "key": "max_score", "value": "214", "description": "Only wallets with a review score at or below this value. Must be at least 0.", "disabled": false }, { "key": "tags", "value": "12,34", "description": "Filter by tag taxonomy: comma-separated category-group ids (the same ids the web facet filters submit). Must not be greater than 1000 characters.", "disabled": false }, { "key": "ids", "value": "175,317", "description": "Filter to specific wallet ids (CSV, up to 100). Must not be greater than 1000 characters.", "disabled": false }, { "key": "slugs", "value": "frostsnap,coin98-fusion-card", "description": "Filter to specific wallet slugs (CSV, up to 100). Must not be greater than 2000 characters.", "disabled": false }, { "key": "sort", "value": "-score", "description": "Comma-separated sort fields; prefix with - for descending. Sortable: score, released_at, assets, pros, cons. Must not be greater than 100 characters.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/wallets\/timeline?page=1&per_page=50&search=ledger&min_score=50&max_score=214&tags=12%2C34&ids=175%2C317&slugs=frostsnap%2Ccoin98-fusion-card&sort=-score" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "The wallet list pinned to `released_at` descending (undated wallets last). Same\nrow shape and pagination envelope as `List wallets`." }, "response": [] }, { "name": "Compare wallets", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/wallets\/compare", "query": [ { "key": "slugs", "value": "frostsnap,coin98-fusion-card", "description": "2\u20134 distinct wallet slugs, comma-separated.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/wallets\/compare?slugs=frostsnap%2Ccoin98-fusion-card" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Side-by-side comparison of 2\u20134 wallets with their full grouped tag taxonomy.\n`data[]` preserves the requested slug order so consumers can render columns\npositionally." }, "response": [] }, { "name": "Get wallet detail", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/wallets\/:slug", "query": [], "raw": "{{baseUrl}}\/api\/v1\/wallets\/:slug", "variable": [ { "id": "slug", "key": "slug", "value": "frostsnap", "description": "The wallet slug." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Full single-wallet profile including the grouped tag taxonomy: `categories` is a\nlist of `{group, tags[]}` where each tag has a slug, name and optional value.\n`meta.top_score` is the highest score across all wallets." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":317,\"slug\":\"frostsnap\",\"name\":\"Frostsnap\",\"score\":125,\"assets\":1,\"pros\":18,\"cons\":0,\"price_model\":\"paid\",\"status\":\"Active\",\"released_at\":null,\"logo\":\"https:\/\/bitculator.com\/storage\/media\/logo\/frostsnap.png\",\"website\":\"https:\/\/frostsnap.com\",\"categories\":[{\"group\":\"type\",\"tags\":[{\"slug\":\"hardware\",\"name\":\"Hardware\",\"value\":null}]},{\"group\":\"storage\",\"tags\":[{\"slug\":\"cold\",\"name\":\"Cold\",\"value\":null}]}]},\"meta\":{\"top_score\":214}}", "name": "" }, { "header": [], "code": 404, "body": "{\"error\":{\"code\":\"not_found\",\"message\":\"Wallet not found.\"}}", "name": "" } ] }, { "name": "Wallet supported coins", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/wallets\/:slug\/assets", "query": [ { "key": "page", "value": "1", "description": "Page number (1-based). Must be at least 1.", "disabled": false }, { "key": "per_page", "value": "50", "description": "Rows per page. The cap is plan-based (Free 100, Starter\/Pro 250); exceeding it returns 422 rather than clamping. Must be at least 1. Must not be greater than 100.", "disabled": false }, { "key": "type", "value": "coin", "description": "Restrict to a single asset type: coin or token.", "disabled": false }, { "key": "status", "value": "active", "description": "Listing status: active, delisted, untracked, progressing, awaiting or preparing. Defaults to all public statuses.", "disabled": false }, { "key": "search", "value": "bitcoin", "description": "Free-text match on name or symbol. Must not be greater than 100 characters.", "disabled": false }, { "key": "min_price", "value": "0.5", "description": "Only coins priced at or above this USD value. Must be at least 0.", "disabled": false }, { "key": "max_price", "value": "100000", "description": "Only coins priced at or below this USD value. Must be at least 0.", "disabled": false }, { "key": "min_marketcap", "value": "1000000", "description": "Only coins with a USD marketcap at or above this value. Must be at least 0.", "disabled": false }, { "key": "max_marketcap", "value": "5000000000000", "description": "Only coins with a USD marketcap at or below this value. Must be at least 0.", "disabled": false }, { "key": "min_volume", "value": "1000000", "description": "Only coins with 24h USD volume at or above this value. Must be at least 0.", "disabled": false }, { "key": "max_volume", "value": "100000000000", "description": "Only coins with 24h USD volume at or below this value. Must be at least 0.", "disabled": false }, { "key": "ids", "value": "38,39", "description": "Filter to specific coin ids (CSV, up to 100 selectors combined with slugs\/symbols). Must not be greater than 1000 characters.", "disabled": false }, { "key": "slugs", "value": "bitcoin,ethereum", "description": "Filter to specific coin slugs (CSV, up to 100 selectors combined). Must not be greater than 2000 characters.", "disabled": false }, { "key": "symbols", "value": "BTC,ETH", "description": "Filter to specific coin symbols (CSV, case-insensitive, up to 100 selectors combined). Must not be greater than 1000 characters.", "disabled": false }, { "key": "sort", "value": "-marketcap", "description": "Comma-separated sort fields; prefix with - for descending. Sortable: marketcap, rank, price, volume_24h, change_24h, change_7d. Must not be greater than 100 characters.", "disabled": false }, { "key": "interval", "value": "24h", "description": "Movers window for \/coins\/gainers and \/coins\/losers only: 24h or 7d.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/wallets\/:slug\/assets?page=1&per_page=50&type=coin&status=active&search=bitcoin&min_price=0.5&max_price=100000&min_marketcap=1000000&max_marketcap=5000000000000&min_volume=1000000&max_volume=100000000000&ids=38%2C39&slugs=bitcoin%2Cethereum&symbols=BTC%2CETH&sort=-marketcap&interval=24h", "variable": [ { "id": "slug", "key": "slug", "value": "frostsnap", "description": "The wallet slug." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Coins the wallet supports, returned in the same shape as `List coins` and\naccepting the same filters\/sort." }, "response": [] } ] }, { "name": "Global Market", "description": "\nMarket-wide aggregates \u2014 total marketcap and volume, asset\/exchange\/pair\/market\ncounts, BTC\/ETH dominance with a rank-based top-3, the market Fear & Greed reading,\nplus a top-100 heatmap and marketcap\/volume history.", "item": [ { "name": "Global market snapshot", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/global", "query": [], "raw": "{{baseUrl}}\/api\/v1\/global" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "One-shot market overview: total marketcap and 24h volume, counts of\ncryptocurrencies \/ tokens \/ exchanges \/ pairs \/ markets, `dominance`\n(BTC & ETH share plus the rank-based `top3`), and the market `fear_greed`\nreading." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"total_marketcap\":2037527560616,\"total_volume_24h\":83977305058,\"total_cryptocurrencies\":134,\"total_tokens\":50,\"total_exchanges\":10,\"total_pairs\":823,\"total_markets\":4172,\"dominance\":{\"btc\":62.07,\"eth\":9.97,\"top3\":[{\"symbol\":\"BTC\",\"domination\":62.07},{\"symbol\":\"ETH\",\"domination\":9.97},{\"symbol\":\"USDT\",\"domination\":8.17}]},\"fear_greed\":{\"score\":15,\"regime\":\"neutral\"},\"last_updated\":\"2026-07-03T10:16:06+00:00\"}}", "name": "" } ] }, { "name": "Market heatmap", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/global\/heatmap", "query": [], "raw": "{{baseUrl}}\/api\/v1\/global\/heatmap" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Top-100 treemap rows plus framing stats (total marketcap\/volume, dominance and\nthe market Fear & Greed score) \u2014 the API twin of the web heatmap." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"slug\":\"bitcoin\",\"name\":\"Bitcoin\",\"symbol\":\"BTC\",\"price\":\"109731.2\",\"marketcap\":2183456789012,\"change_24h\":1.24,\"change_7d\":-2.31,\"logo\":\"https:\/\/bitculator.com\/storage\/media\/assets\/bitcoin-small.png\"}],\"meta\":{\"total_marketcap\":3456789012345,\"total_volume_24h\":98765432109,\"dominance\":{\"btc\":63.2,\"eth\":9.1,\"top3\":74.6},\"fear_greed\":15}}", "name": "" } ] }, { "name": "Global marketcap \/ volume history", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/global\/history\/:metric", "query": [ { "key": "period", "value": "7d", "description": "24h, 7d, 30d or all (default 24h).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/global\/history\/:metric?period=7d", "variable": [ { "id": "metric", "key": "metric", "value": "marketcap", "description": "Which series: marketcap or volume." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Total-market time series for `marketcap` or `volume`. Granularity follows the\n`period`: 24h = half-hourly, 7d = hourly, 30d\/all = daily (finer rollups are\npruned)." }, "response": [] } ] }, { "name": "Sentiment", "description": "\nMarket and per-coin sentiment indices. Fear & Greed and Bull\/Bear are\n15-minute-refresh SNAPSHOTS \u2014 only the current reading exists, there is no time\nseries for them. Altseason carries full daily history. `indicators` is the\nmarket-wide technical tally.", "item": [ { "name": "Community vote tallies", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/coins\/:slug\/votes", "query": [], "raw": "{{baseUrl}}\/api\/v1\/coins\/:slug\/votes", "variable": [ { "id": "slug", "key": "slug", "value": "bitcoin", "description": "The coin's slug identifier." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "The coin's bullish\/bearish community tallies over the rolling 24h window." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"coin\":\"bitcoin\",\"bullish\":184,\"bearish\":42,\"total\":226}}", "name": "" } ] }, { "name": "Cast a sentiment vote", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/coins\/:slug\/votes", "query": [], "raw": "{{baseUrl}}\/api\/v1\/coins\/:slug\/votes", "variable": [ { "id": "slug", "key": "slug", "value": "bitcoin", "description": "The coin's slug identifier." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"vote\":\"bullish\"}" }, "description": "Casts the key owner's sentiment vote for a coin. One vote per key owner per coin\nper rolling 24h window \u2014 re-voting inside the window updates the existing vote." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"coin\":\"bitcoin\",\"bullish\":185,\"bearish\":42,\"total\":227,\"your_vote\":\"bullish\"}}", "name": "" } ] }, { "name": "Fear & Greed index", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/sentiment\/fear-greed", "query": [ { "key": "coin", "value": "bitcoin", "description": "Coin slug for a per-coin reading; omit for the market index.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/sentiment\/fear-greed?coin=bitcoin" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "The current Fear & Greed reading (a 15-minute snapshot \u2014 no history). Omit `coin`\nfor the market-wide index, or pass a coin slug for a per-coin reading. `intervals`\ncarries the 7d\/30d sub-scores and their component breakdown." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"scope\":\"market\",\"score\":15,\"regime\":\"neutral\",\"intervals\":{\"7d\":{\"score\":15,\"regime\":\"neutral\",\"breakdown\":{\"volume\":40,\"breadth\":1,\"momentum\":-8,\"volatility\":36},\"score_normalized\":15},\"30d\":{\"score\":18,\"regime\":\"neutral\",\"breakdown\":{\"volume\":80,\"breadth\":1,\"momentum\":-10,\"volatility\":18},\"score_normalized\":18}}}}", "name": "" }, { "header": [], "code": 404, "body": "{\"error\":{\"code\":\"not_found\",\"message\":\"No fear & greed data for this scope.\"}}", "name": "" } ] }, { "name": "Bull \/ Bear index", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/sentiment\/bull-bear", "query": [ { "key": "coin", "value": "bitcoin", "description": "Coin slug for a per-coin reading; omit for the market index.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/sentiment\/bull-bear?coin=bitcoin" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "The current Bull\/Bear reading (a 15-minute snapshot \u2014 no history). Omit `coin`\nfor the market-wide index, or pass a coin slug for a per-coin reading." }, "response": [] }, { "name": "Altseason index", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/sentiment\/altseason", "query": [ { "key": "days", "value": "30", "description": "Days of daily history to include (1\u2013365; 0\/omit = current only).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/sentiment\/altseason?days=30" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "The current altseason reading (count of coins beating BTC out of the top 100),\nwith optional daily `history`. Unlike Fear & Greed, altseason has full daily\nhistory \u2014 pass `days` to include it." }, "response": [] }, { "name": "Market indicator tally", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/sentiment\/indicators", "query": [], "raw": "{{baseUrl}}\/api\/v1\/sentiment\/indicators" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "The market-wide technical tally \u2014 25 indicator categories rolled up, each with\nits current state, score and category data." }, "response": [] } ] }, { "name": "Indicators", "description": "\nPer-coin technical indicators \u2014 a multi-indicator snapshot plus per-family daily\ntime series. All families are DAILY series computed from daily candles (full\nretention; young assets return warm-up `null`s until enough history exists).\nPrice-scale families (sma, vwap, macd, obv) emit decimal strings; bounded\noscillators emit numbers. Some long-window periods require a paid plan (see the\nfamily endpoint).", "item": [ { "name": "Indicator snapshot", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/coins\/:slug\/indicators", "query": [], "raw": "{{baseUrl}}\/api\/v1\/coins\/:slug\/indicators", "variable": [ { "id": "slug", "key": "slug", "value": "bitcoin", "description": "The coin slug." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "The multi-indicator snapshot \u2014 every indicator category's latest `state`\n(bullish\/bearish\/sheepish\u2026), `score` and raw `data`, in one payload." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"indicator\":\"OBV\",\"state\":\"bearish\",\"score\":-1,\"data\":{\"value\":1755907904411,\"window\":21}},{\"indicator\":\"macd\",\"state\":\"bullish\",\"score\":1,\"data\":{\"value\":-2811.87686067,\"signal\":-3364.35539147,\"histogram\":552.4785308}}],\"meta\":{\"coin\":\"bitcoin\"}}", "name": "" }, { "header": [], "code": 404, "body": "{\"error\":{\"code\":\"not_found\",\"message\":\"No indicator data for this coin yet.\"}}", "name": "" } ] }, { "name": "Indicator family series", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/coins\/:slug\/indicators\/:family", "query": [ { "key": "period", "value": "14", "description": "Window length (only where the family has windows; must be one of that family's valid windows).", "disabled": false }, { "key": "start", "value": "2026-06-01", "description": "ISO date lower bound.", "disabled": false }, { "key": "end", "value": "2026-06-30", "description": "ISO date upper bound.", "disabled": false }, { "key": "limit", "value": "30", "description": "Max rows (1\u20131000, default 365).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/coins\/:slug\/indicators\/:family?period=14&start=2026-06-01&end=2026-06-30&limit=30", "variable": [ { "id": "slug", "key": "slug", "value": "bitcoin", "description": "The coin slug." }, { "id": "family", "key": "family", "value": "rsi", "description": "Indicator family \u2014 one of rsi, stoch-rsi, sma, cci, mfi, williams-r, price-volatility, volume-volatility, macd, obv, adx, vwap, cmf." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "One indicator family's daily time series. Families with multiple windows accept a\n`period`, and the valid windows differ per family: RSI\/Stoch-RSI 7\/14\/21\/28,\nSMA 50\/100\/200, CCI 20\/50\/100, MFI 7\/14\/28, Williams %R 14\/20\/50,\nprice\/volume-volatility 7\/14\/30. Single-series families (MACD, OBV, ADX, VWAP,\nCMF) ignore `period`. Young coins return leading warm-up `null`s.\n\nSome long windows require a paid plan: RSI & Stoch-RSI 21\/28-day and the 30-day\nvolatility windows need Starter or higher \u2014 requesting them on the Free plan\nreturns 403 with code `plan_required`." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"date\":\"2026-06-14\",\"value\":42},{\"date\":\"2026-06-15\",\"value\":46}],\"meta\":{\"coin\":\"bitcoin\",\"indicator\":\"rsi\",\"period\":14,\"count\":2}}", "name": "" }, { "header": [], "code": 403, "body": "{\"error\":{\"code\":\"plan_required\",\"message\":\"The 28-day rsi window requires the Starter plan or higher.\",\"details\":{\"required_plan\":\"starter\"}}}", "name": "" }, { "header": [], "code": 404, "body": "{\"error\":{\"code\":\"not_found\",\"message\":\"Unknown indicator. Families: rsi, stoch-rsi, sma, cci, mfi, williams-r, price-volatility, volume-volatility, macd, obv, adx, vwap, cmf.\"}}", "name": "" } ] } ] }, { "name": "Liquidations", "description": "\nDerivatives liquidations. Source coverage is currently OKX swap markets only\n(stated in every `meta.note`). The RAW feed (the `\/liquidations` list and the\nhourly breakdown) is pruned after ~48 hours; daily rollups are kept forever.\nToday's aggregates are partial and update every ~15 minutes.", "item": [ { "name": "Liquidation feed", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/liquidations", "query": [ { "key": "page", "value": "1", "description": "Page number (1-based). Must be at least 1.", "disabled": false }, { "key": "per_page", "value": "50", "description": "Rows per page. The cap is plan-based (Free 100, Starter\/Pro 250); exceeding it returns 422 rather than clamping. Must be at least 1. Must not be greater than 100.", "disabled": false }, { "key": "exchange", "value": "okx", "description": "Restrict to a single exchange by slug. Source coverage is currently OKX swap markets. Must match the regex \/^[a-z0-9\\-]{1,120}$\/.", "disabled": false }, { "key": "instrument", "value": "swap", "description": "Instrument type: future, option, swap, spot or margin.", "disabled": false }, { "key": "position", "value": "short", "description": "Liquidated position side: long or short.", "disabled": false }, { "key": "order", "value": "buy", "description": "Fill side that triggered the liquidation: buy or sell.", "disabled": false }, { "key": "symbol", "value": "BTC", "description": "Prefix match on the venue instId (e.g. BTC matches BTC-USDT-SWAP). Must match the regex \/^[A-Za-z0-9$\\.\\-]{1,25}$\/.", "disabled": false }, { "key": "min_usd", "value": "1000", "description": "Only liquidations with a USD value at or above this threshold. Must be at least 0.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/liquidations?page=1&per_page=50&exchange=okx&instrument=swap&position=short&order=buy&symbol=BTC&min_usd=1000" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "The raw liquidation feed (~last 48h, then pruned), newest first. Source coverage\nis currently OKX swap markets. Prices are decimal strings. `meta` carries the\npagination fields plus a `retention` and `note`." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"symbol\":\"NEAR-USDT-SWAP\",\"exchange\":{\"id\":20,\"slug\":\"okx\",\"name\":\"OKX\"},\"instrument\":\"swap\",\"position\":\"short\",\"order\":\"buy\",\"price\":\"2.245\",\"value_usd\":5727.73,\"quantity\":259.1,\"liquidated_at\":\"2026-06-21T07:39:41+00:00\"}],\"meta\":{\"current_page\":1,\"per_page\":50,\"total\":4681,\"last_page\":94,\"retention\":\"~48 hours (raw feed is pruned)\",\"note\":\"Source coverage: OKX swap markets.\"}}", "name": "" } ] }, { "name": "Hourly liquidations", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/liquidations\/hourly", "query": [ { "key": "hours", "value": "24", "description": "Look-back window in hours (1\u201348, default 24).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/liquidations\/hourly?hours=24" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Hourly long\/short USD totals over the raw feed. Because the raw feed is pruned at\n~48h, `hours` is capped at 48. Source coverage is currently OKX swap markets." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"hour\":\"2026-07-03T08:00:00+00:00\",\"liquidations\":112,\"total_usd\":1834567.21,\"long_usd\":1034567.11,\"short_usd\":800000.1}],\"meta\":{\"hours\":24,\"note\":\"Source coverage: OKX swap markets.\"}}", "name": "" } ] }, { "name": "Daily liquidations", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/liquidations\/daily", "query": [ { "key": "days", "value": "30", "description": "Number of calendar days incl. today (1\u2013365, default 30).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/liquidations\/daily?days=30" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Daily aggregates (kept forever), summed across exchanges\/instruments per day \u2014\ntotal\/long\/short USD plus long\/short position counts. Today's row is partial and\nupdates every ~15 minutes. Source coverage is currently OKX swap markets." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"date\":\"2026-07-02\",\"total_usd\":27888888.76,\"long_usd\":18345672.1,\"short_usd\":9543216.66,\"longs\":4231,\"shorts\":2614}],\"meta\":{\"days\":30,\"note\":\"Source coverage: OKX swap markets.\"}}", "name": "" } ] }, { "name": "Today's liquidation summary", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/liquidations\/summary", "query": [], "raw": "{{baseUrl}}\/api\/v1\/liquidations\/summary" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Today so far \u2014 total\/long\/short USD, position counts and long-vs-short\n`dominance`. Figures are partial and update every ~15 minutes; `data` is null\nuntil the first liquidation of the day is recorded. Source coverage is currently\nOKX swap markets." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"date\":\"2026-07-03\",\"total_usd\":12345678.9,\"long_usd\":8345678.9,\"short_usd\":4000000,\"longs\":1834,\"shorts\":961,\"dominance\":{\"long\":67.6,\"short\":32.4}},\"meta\":{\"note\":\"Source coverage: OKX swap markets. Today's figures are partial and update every ~15 minutes.\"}}", "name": "" } ] }, { "name": "Liquidation netflow", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/liquidations\/netflow", "query": [ { "key": "days", "value": "30", "description": "Number of calendar days incl. today (1\u201390, default 30).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/liquidations\/netflow?days=30" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Long-vs-short liquidation USD flow per day over the window. Source coverage is\ncurrently OKX swap markets." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"date\":\"2026-07-02\",\"long\":1834567.21,\"short\":954321.55,\"total\":2788888.76,\"longs\":420,\"shorts\":261}],\"meta\":{\"days\":30,\"note\":\"Source coverage: OKX swap markets.\"}}", "name": "" } ] }, { "name": "Top liquidated coins", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/liquidations\/coins", "query": [ { "key": "hours", "value": "24", "description": "Look-back window in hours (1\u201348, default 24).", "disabled": false }, { "key": "limit", "value": "8", "description": "Number of coins to return (1\u201320, default 8).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/liquidations\/coins?hours=24&limit=8" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Top coins by liquidation volume over the recent window, with the long\/short USD\nsplit per coin. Source coverage is currently OKX swap markets." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"symbol\":\"BTC\",\"name\":\"Bitcoin\",\"slug\":\"bitcoin\",\"logo\":\"https:\/\/bitculator.com\/storage\/media\/assets\/bitcoin-small.png\",\"long\":734567.21,\"short\":954321.55,\"total\":1688888.76}],\"meta\":{\"hours\":24,\"note\":\"Source coverage: OKX swap markets.\"}}", "name": "" } ] } ] }, { "name": "Conversion", "description": "\nConvert between any two active assets (crypto AND fiat), and list the currencies\nusable as conversion legs. Values are decimal strings. Fiat FX rates refresh\n~twice daily; crypto rates ~every minute.", "item": [ { "name": "Convert between assets", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/convert", "query": [ { "key": "from", "value": "bitcoin", "description": "Source asset slug.", "disabled": false }, { "key": "to", "value": "ethereum", "description": "Target asset slug(s), comma-separated (up to 10).", "disabled": false }, { "key": "amount", "value": "2.5", "description": "Amount of the source asset to convert (default 1).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/convert?from=bitcoin&to=ethereum&amount=2.5" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Server-side conversion between any two active assets (crypto AND fiat). `to`\naccepts a CSV for multi-target conversion; reversing is just swapping `from`\/`to`.\nConversion is linear, so `value = unit_rate * amount`. Fiat FX rates refresh\n~twice daily; crypto rates ~every minute." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"from\":{\"slug\":\"bitcoin\",\"symbol\":\"BTC\"},\"amount\":1,\"results\":[{\"slug\":\"ethereum\",\"symbol\":\"ETH\",\"value\":\"37.980395960595\"}]}}", "name": "" }, { "header": [], "code": 404, "body": "{\"error\":{\"code\":\"not_found\",\"message\":\"Unknown currency: dogecoinx.\"}}", "name": "" } ] }, { "name": "List fiat currencies", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/fiats", "query": [], "raw": "{{baseUrl}}\/api\/v1\/fiats" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "The active fiat currencies with their USD FX rates: `rate_per_usd` (units per\nUSD) and its inverse `usd_value`. Fiat FX rates refresh ~twice daily." }, "response": [] }, { "name": "List conversion rates", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/rates", "query": [], "raw": "{{baseUrl}}\/api\/v1\/rates" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "The vs-currencies usable as conversion legs \u2014 the top fiats, coins and tokens \u2014\neach with a normalized `usd_value` (USD per one unit). Coin\/token values refresh\n~every minute; the slow fiat rates are cached separately (~twice daily)." }, "response": [] } ] }, { "name": "Calculators", "description": "\nServer-side financial calculators mirroring the web tools: DCA, profit\/loss and\nloan (which read cached market data), plus stateless compound-interest and staking\nmath.", "item": [ { "name": "DCA calculator", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/calculators\/dca", "query": [ { "key": "slug", "value": "bitcoin", "description": "The coin's slug identifier.", "disabled": false }, { "key": "amount", "value": "100", "description": "USD spent per purchase (0.01\u20131,000,000,000).", "disabled": false }, { "key": "interval", "value": "weekly", "description": "Purchase cadence: `daily`, `weekly`, `monthly`, `quarterly` or `yearly`.", "disabled": false }, { "key": "start", "value": "2024-01-01", "description": "date First purchase date (after 2008-12-31).", "disabled": false }, { "key": "end", "value": "2025-01-01", "description": "date Last purchase date (defaults to today).", "disabled": false }, { "key": "series", "value": "", "description": "Include the per-purchase series in the payload.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/calculators\/dca?slug=bitcoin&amount=100&interval=weekly&start=2024-01-01&end=2025-01-01&series=" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Dollar-cost averaging backtest over the coin's real daily price history: one buy\nof `amount` per `interval` between `start` and `end`. Pass `series=true` to\ninclude the full per-purchase series." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"summary\":{\"purchases\":53,\"invested\":5300,\"accumulated\":0.0754210998,\"final_value\":7098.9,\"profit\":1798.9,\"roi\":33.94},\"series\":null},\"meta\":{\"coin\":\"bitcoin\",\"interval\":\"weekly\",\"start\":\"2024-01-01\",\"end\":\"2025-01-01\",\"amount_per_buy\":100,\"currency\":\"USD\"}}", "name": "" } ] }, { "name": "Profit \/ loss calculator", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/calculators\/profit-loss", "query": [ { "key": "slug", "value": "bitcoin", "description": "The coin's slug identifier.", "disabled": false }, { "key": "amount", "value": "1000", "description": "USD invested at `buy_date` (0.01\u20131,000,000,000).", "disabled": false }, { "key": "buy_date", "value": "2023-01-01", "description": "date Purchase date.", "disabled": false }, { "key": "sell_date", "value": "2025-01-01", "description": "date Sale date (on\/after `buy_date`).", "disabled": false }, { "key": "buy_fee", "value": "10", "description": "Flat purchase fee in USD (default 0).", "disabled": false }, { "key": "sell_fee", "value": "10", "description": "Flat sale fee in USD (default 0).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/calculators\/profit-loss?slug=bitcoin&amount=1000&buy_date=2023-01-01&sell_date=2025-01-01&buy_fee=10&sell_fee=10" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "What a buy-then-sell between two historical dates returned, using the coin's real\nprices on those dates. Fees are flat USD amounts, not percentages." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"buy_price\":\"16625.08\",\"sell_price\":\"93429.2\",\"quantity\":0.0595486254,\"investment_worth\":5563.58,\"total_fees\":20,\"profit\":4553.58,\"roi\":455.36},\"meta\":{\"coin\":\"bitcoin\",\"amount\":1000,\"buy_date\":\"2023-01-01\",\"sell_date\":\"2025-01-01\",\"buy_fee\":10,\"sell_fee\":10,\"currency\":\"USD\"}}", "name": "" } ] }, { "name": "Compound interest calculator", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/calculators\/compound-interest", "query": [ { "key": "principal", "value": "10000", "description": "Starting balance in USD.", "disabled": false }, { "key": "rate", "value": "1", "description": "Interest rate in % per compounding period.", "disabled": false }, { "key": "duration", "value": "5", "description": "Length of the projection (years are capped at 50).", "disabled": false }, { "key": "duration_unit", "value": "years", "description": "`years` (default) or `months`.", "disabled": false }, { "key": "compound_frequency", "value": "monthly", "description": "`daily`, `weekly`, `monthly` (default), `quarterly` or `annually`.", "disabled": false }, { "key": "contribution", "value": "100", "description": "Recurring deposit in USD (default 0).", "disabled": false }, { "key": "contribution_frequency", "value": "monthly", "description": "`daily`, `weekly`, `monthly` (default), `quarterly` or `annually`.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/calculators\/compound-interest?principal=10000&rate=1&duration=5&duration_unit=years&compound_frequency=monthly&contribution=100&contribution_frequency=monthly" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Pure math \u2014 no market data. Note that the rate applies PER COMPOUNDING PERIOD\n(the web calculator's convention), not per year." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"final_balance\":24471.19,\"total_contributions\":16000,\"total_interest\":8471.19,\"roi\":52.94},\"meta\":{\"note\":\"The rate applies per compounding period (web calculator parity), not per year.\"}}", "name": "" } ] }, { "name": "Loan vs sell calculator", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/calculators\/loan", "query": [ { "key": "slug", "value": "bitcoin", "description": "The coin's slug identifier.", "disabled": false }, { "key": "crypto_amount", "value": "2", "description": "How much of the coin you hold.", "disabled": false }, { "key": "needed_cash", "value": "50000", "description": "USD you need to free up.", "disabled": false }, { "key": "term_months", "value": "36", "description": "Loan term in months (default 36).", "disabled": false }, { "key": "interest_rate", "value": "10", "description": "Loan APR in % (default 10).", "disabled": false }, { "key": "ltv", "value": "50", "description": "Loan-to-value ratio in % (default 50).", "disabled": false }, { "key": "expected_growth", "value": "25", "description": "Expected coin price growth over the term in % (default 25).", "disabled": false }, { "key": "tax_rate", "value": "25", "description": "Capital-gains tax in % applied to the sale (default 25).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/calculators\/loan?slug=bitcoin&crypto_amount=2&needed_cash=50000&term_months=36&interest_rate=10<v=50&expected_growth=25&tax_rate=25" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Borrow against crypto vs sell it \u2014 compares both scenarios using the coin's\nCURRENT price. Informational projection, not financial advice." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"current_price\":\"109731.2\",\"collateral_value\":219462.4,\"max_loan\":109731.2,\"loan_possible\":true,\"loan_scenario\":{\"monthly_payment\":1613.4,\"total_payback\":58082.4,\"total_interest\":8082.4,\"net_value\":216296.72},\"sell_scenario\":{\"crypto_sold\":0.4556647344,\"capital_gains_tax\":12500,\"net_value\":230378.86},\"better_scenario\":\"sell\",\"opportunity_cost\":14082.14,\"break_even_growth\":31.42,\"risk_level\":\"medium\"},\"meta\":{\"coin\":\"bitcoin\",\"currency\":\"USD\",\"note\":\"Informational projection \u2014 the tax model taxes the full proceeds (no cost basis), matching the web calculator.\"}}", "name": "" } ] }, { "name": "Staking rewards calculator", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/calculators\/staking", "query": [ { "key": "amount", "value": "1000", "description": "Amount staked, in the staked asset's units.", "disabled": false }, { "key": "period", "value": "2", "description": "Length of the staking period (capped at the 50-year equivalent).", "disabled": false }, { "key": "period_unit", "value": "years", "description": "`years` (default), `months` or `days`.", "disabled": false }, { "key": "apy", "value": "5", "description": "Advertised APY in %.", "disabled": false }, { "key": "compound_frequency", "value": "monthly", "description": "`never`, `daily`, `weekly`, `monthly` (default) or `yearly`.", "disabled": false }, { "key": "commission", "value": "10", "description": "Validator commission in %, taken from rewards (default 0).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/calculators\/staking?amount=1000&period=2&period_unit=years&apy=5&compound_frequency=monthly&commission=10" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Pure math \u2014 staking rewards with optional compounding and a validator\ncommission. No market data is read." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"final_balance\":1094.42,\"total_rewards\":94.42,\"yearly_reward\":47.21,\"monthly_reward\":3.93,\"roi\":9.44,\"risk_level\":\"low\"}}", "name": "" } ] } ] }, { "name": "Editorial", "description": "\nEditorial articles \u2014 published (ACTIVE) only. `locale` picks the content language\nwith per-field English fallback (the payload reports which `locale` actually won).\nArticles can be filtered by tag or by a related coin\/exchange\/wallet slug. API\nreads deliberately do NOT increment view counts.", "item": [ { "name": "Coin videos", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/coins\/:slug\/videos", "query": [ { "key": "page", "value": "1", "description": "Page number (1-based).", "disabled": false }, { "key": "per_page", "value": "10", "description": "Rows per page (1\u201350, default 10).", "disabled": false }, { "key": "type", "value": "review", "description": "Filter by video type (e.g. `overview`, `tutorial`, `explainer`, `review`, `analysis`, `news`).", "disabled": false }, { "key": "search", "value": "halving", "description": "Free-text match on the title.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/coins\/:slug\/videos?page=1&per_page=10&type=review&search=halving", "variable": [ { "id": "slug", "key": "slug", "value": "bitcoin", "description": "The coin's slug identifier." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Curated videos attached to a coin (the coin page's Videos tab), paginated." }, "response": [] }, { "name": "Coin insight timeline", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/coins\/:slug\/insights", "query": [ { "key": "locale", "value": "en", "description": "Content language (falls back to English).", "disabled": false }, { "key": "offset", "value": "0", "description": "Rows to skip (0\u2013500, default 0).", "disabled": true }, { "key": "limit", "value": "5", "description": "Rows to return (1\u201350, default 5).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/coins\/:slug\/insights?locale=en&offset=0&limit=5", "variable": [ { "id": "slug", "key": "slug", "value": "bitcoin", "description": "The coin's slug identifier." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "The coin's insight timeline \u2014 the same payload the asset page's insights panel\nuses, windowed by `offset`\/`limit`." }, "response": [] }, { "name": "List articles", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/articles", "query": [ { "key": "page", "value": "1", "description": "Page number (1-based).", "disabled": false }, { "key": "per_page", "value": "20", "description": "Rows per page (1\u201350, default 20).", "disabled": false }, { "key": "locale", "value": "en", "description": "Content language (falls back to English).", "disabled": false }, { "key": "tag", "value": "guide", "description": "Filter by tag: news, guide, tutorial, explainer, analysis, review, trading, overview or information.", "disabled": false }, { "key": "coin", "value": "bitcoin", "description": "Filter to articles related to this coin slug.", "disabled": false }, { "key": "exchange", "value": "binance-exchange", "description": "Filter to articles related to this exchange slug.", "disabled": false }, { "key": "wallet", "value": "frostsnap", "description": "Filter to articles related to this wallet slug.", "disabled": false }, { "key": "search", "value": "halving", "description": "Free-text match on heading\/subheading.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/articles?page=1&per_page=20&locale=en&tag=guide&coin=bitcoin&exchange=binance-exchange&wallet=frostsnap&search=halving" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Published articles, newest first, paginated. Filter by `tag` or by a related\n`coin` \/ `exchange` \/ `wallet` slug, or free-text `search`. Each row is a summary\n(title, subtitle, tags, reading time, hero image, related entities, dates)." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":14,\"slug\":\"what-is-bitcoin\",\"title\":\"What Is Bitcoin?\",\"subtitle\":\"A plain-language introduction to the first cryptocurrency.\",\"locale\":\"en\",\"tags\":[\"guide\",\"analysis\"],\"reading_time_minutes\":7,\"hero_image\":\"https:\/\/bitculator.com\/storage\/media\/articles\/what-is-bitcoin.png\",\"entities\":[],\"published_at\":\"2026-06-21\",\"updated_at\":\"2026-06-21\"}],\"meta\":{\"current_page\":1,\"per_page\":20,\"total\":10,\"last_page\":1}}", "name": "" } ] }, { "name": "Get an article", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/articles\/:slug", "query": [ { "key": "locale", "value": "en", "description": "Content language (falls back to English).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/articles\/:slug?locale=en", "variable": [ { "id": "slug", "key": "slug", "value": "what-is-bitcoin", "description": "The article's slug." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "One published article with its full body, tags, hero image, helpful counters and\nrelated entities. `locale` picks the content language with per-field English\nfallback (the payload reports which locale actually won)." }, "response": [] }, { "name": "Submit article feedback", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/articles\/:slug\/feedback", "query": [], "raw": "{{baseUrl}}\/api\/v1\/articles\/:slug\/feedback", "variable": [ { "id": "slug", "key": "slug", "value": "what-is-bitcoin", "description": "The article's slug." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"helpful\":true}" }, "description": "Registers a thumbs-up\/down on an article \u2014 the same counters the web's helpful\nbuttons use. Per-key throttling applies upstream." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"article\":\"what-is-bitcoin\",\"helpful_yes\":13,\"helpful_no\":2}}", "name": "" } ] }, { "name": "Get a video", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/videos\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/videos\/:id", "variable": [ { "id": "id", "key": "id", "value": 87, "description": "The video id." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "One curated video with its YouTube id, title, type, duration and the\ncoins\/exchanges\/wallets it is attached to." }, "response": [] }, { "name": "List insights", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/insights", "query": [ { "key": "page", "value": "1", "description": "Page number (1-based).", "disabled": false }, { "key": "per_page", "value": "20", "description": "Rows per page (1\u201350, default 20).", "disabled": false }, { "key": "locale", "value": "en", "description": "Content language (falls back to English).", "disabled": false }, { "key": "type", "value": "per_asset", "description": "Filter by insight type: `per_asset`, `market_overview` or `narrative`.", "disabled": false }, { "key": "coin", "value": "bitcoin", "description": "Filter to insights about this coin slug.", "disabled": false }, { "key": "search", "value": "etf", "description": "Free-text match on the headline.", "disabled": false }, { "key": "sort", "value": "first_reported", "description": "Sort order: `first_reported` (default) or `last_updated`.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/insights?page=1&per_page=20&locale=en&type=per_asset&coin=bitcoin&search=etf&sort=first_reported" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "AI-generated market insights, paginated. Filter by `type`, a related `coin` slug\nor free-text `search`; `locale` picks the headline\/summary language with English\nfallback." }, "response": [] }, { "name": "Get an insight", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/insights\/:id", "query": [ { "key": "locale", "value": "en", "description": "Content language (falls back to English).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/insights\/:id?locale=en", "variable": [ { "id": "id", "key": "id", "value": 101, "description": "The insight id." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "One insight with its full payload \u2014 headline, summary, source-article timeline\nand related coins." }, "response": [] } ] }, { "name": "Alarms", "description": "\nPrice-alarm CRUD \u2014 the same alarms the web app manages. Alarms consume the key\nowner's alarm inventory balance, are TARGET-type on coins only, and an above\/below\nvs current-value guard blocks alarms that would self-trigger instantly. Key-scoped\n(the API key sets the owner) and never response-cached.", "item": [ { "name": "List alarms", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/alarms", "query": [ { "key": "page", "value": "1", "description": "Page number (1-based).", "disabled": false }, { "key": "per_page", "value": "25", "description": "Rows per page (1\u2013100, default 25).", "disabled": false }, { "key": "status", "value": "active", "description": "Filter by state: `active` or `triggered`.", "disabled": false }, { "key": "direction", "value": "above", "description": "Filter by trigger direction: `above` or `below`.", "disabled": false }, { "key": "notification", "value": "email", "description": "Filter by delivery channel: `email`, `push` or `webhook`.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/alarms?page=1&per_page=25&status=active&direction=above¬ification=email" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "The key owner's alarms, newest first, paginated. Filter by `status`, `direction`\nor `notification` channel." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":42,\"name\":\"BTC six figures\",\"coin\":{\"slug\":\"bitcoin\",\"symbol\":\"BTC\",\"name\":\"Bitcoin\"},\"metric\":\"rate\",\"direction\":\"above\",\"target\":\"100000\",\"notification\":\"email\",\"status\":\"active\",\"created_at\":\"2026-06-21T09:15:00+00:00\"}],\"meta\":{\"current_page\":1,\"per_page\":25,\"total\":3,\"last_page\":1}}", "name": "" } ] }, { "name": "Create an alarm", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/alarms", "query": [], "raw": "{{baseUrl}}\/api\/v1\/alarms" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"BTC six figures\",\"coin\":\"bitcoin\",\"metric\":\"rate\",\"direction\":\"above\",\"target\":100000,\"notification\":\"email\"}" }, "description": "Creates a TARGET alarm on a coin and spends one alarm slot from the key owner's\nbalance. The target is checked against the coin's current value so the alarm\ncannot self-trigger instantly: an `above` alarm must target more than the current\nvalue, a `below` alarm less." }, "response": [ { "header": [], "code": 201, "body": "{\"data\":{\"id\":43,\"name\":\"BTC six figures\",\"coin\":{\"slug\":\"bitcoin\",\"symbol\":\"BTC\",\"name\":\"Bitcoin\"},\"metric\":\"rate\",\"direction\":\"above\",\"target\":\"100000\",\"notification\":\"email\",\"status\":\"active\",\"created_at\":\"2026-07-03T08:00:00+00:00\"}}", "name": "" } ] }, { "name": "Delete an alarm", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/alarms\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/alarms\/:id", "variable": [ { "id": "id", "key": "id", "value": 42, "description": "The alarm id." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Deletes one of the key owner's alarms and refunds the alarm slot it consumed." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"deleted\":true}}", "name": "" } ] } ] }, { "name": "Webhooks", "description": "\nBitculator POSTs each event as JSON with an HMAC signature header:\n\n X-Bitculator-Signature: t=,v1=.\", secret)>\n X-Bitculator-Event: alarm.triggered\n\nVerify it by recomputing the HMAC over \".\" with your\nendpoint secret and comparing in constant time; reject if `t` is older than a\nfew minutes (replay guard). Example (PHP):\n\n [$t, $v1] = sscanf($_SERVER['HTTP_X_BITCULATOR_SIGNATURE'], 't=%d,v1=%s');\n $expected = hash_hmac('sha256', $t.'.'.file_get_contents('php:\/\/input'), $secret);\n abort_unless(hash_equals($expected, $v1) && abs(time() - $t) < 300, 403);\n\nSupported events: `alarm.triggered`. Deliveries retry 3\u00d7 with backoff; an\nendpoint auto-disables after 10 consecutive failed deliveries.", "item": [ { "name": "List webhook endpoints", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/webhooks", "query": [], "raw": "{{baseUrl}}\/api\/v1\/webhooks" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "The key owner's webhook endpoints, newest first. Signing secrets are never\nincluded \u2014 each secret is shown exactly once, at creation." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":7,\"url\":\"https:\/\/example.com\/webhooks\/bitculator\",\"events\":[\"alarm.triggered\"],\"status\":\"active\",\"consecutive_failures\":0,\"disabled_at\":null,\"created_at\":\"2026-06-20T10:00:00+00:00\"}]}", "name": "" } ] }, { "name": "Create a webhook endpoint", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/webhooks", "query": [], "raw": "{{baseUrl}}\/api\/v1\/webhooks" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"url\":\"https:\\\/\\\/example.com\\\/webhooks\\\/bitculator\",\"events\":[\"alarm.triggered\"]}" }, "description": "Registers an HTTPS endpoint (max 5 per account) for event deliveries. The\nresponse includes the signing `secret` \u2014 the ONLY time it is ever shown, so\nstore it immediately." }, "response": [ { "header": [], "code": 201, "body": "{\"data\":{\"id\":8,\"url\":\"https:\/\/example.com\/webhooks\/bitculator\",\"events\":[\"alarm.triggered\"],\"status\":\"active\",\"consecutive_failures\":0,\"disabled_at\":null,\"created_at\":\"2026-07-03T08:00:00+00:00\",\"secret\":\"whsec_k5cQ1x9jJ2mW7pR4tY8uB3nV6zA0sD5f\"}}", "name": "" } ] }, { "name": "Delete a webhook endpoint", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/webhooks\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/webhooks\/:id", "variable": [ { "id": "id", "key": "id", "value": 7, "description": "The webhook endpoint id." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Deletes one of the key owner's webhook endpoints. Pending deliveries to it are\nabandoned." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"deleted\":true}}", "name": "" } ] }, { "name": "Send a test event", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/webhooks\/:id\/test", "query": [], "raw": "{{baseUrl}}\/api\/v1\/webhooks\/:id\/test", "variable": [ { "id": "id", "key": "id", "value": 7, "description": "The webhook endpoint id." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Fires a signed `alarm.triggered` test event (`test: true` in the payload, real\nsignature headers) so receivers can be verified end-to-end." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"queued\":true}}", "name": "" } ] }, { "name": "Webhook delivery log", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/webhooks\/:id\/deliveries", "query": [ { "key": "page", "value": "1", "description": "Page number (1-based).", "disabled": false }, { "key": "per_page", "value": "25", "description": "Rows per page (1\u2013100, default 25).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/webhooks\/:id\/deliveries?page=1&per_page=25", "variable": [ { "id": "id", "key": "id", "value": 7, "description": "The webhook endpoint id." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "The endpoint's delivery attempts (kept 30 days), newest first, paginated." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":311,\"event\":\"alarm.triggered\",\"response_status\":200,\"error\":null,\"attempts\":1,\"delivered_at\":\"2026-07-02T21:14:09+00:00\",\"created_at\":\"2026-07-02T21:14:08+00:00\"}],\"meta\":{\"current_page\":1,\"per_page\":25,\"total\":6,\"last_page\":1,\"retention\":\"30 days\"}}", "name": "" } ] } ] }, { "name": "Meta", "description": "\nAPI meta and introspection: an authenticated ping to verify a key and the\nmiddleware stack, current-key usage\/quota, and the machine-readable OpenAPI spec.", "item": [ { "name": "OpenAPI spec", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/openapi.json", "query": [], "raw": "{{baseUrl}}\/api\/v1\/openapi.json" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "The machine-readable OpenAPI 3 document for this API, as JSON \u2014 point codegen\nor API tooling at this URL. Public: no key required." }, "response": [] }, { "name": "Ping", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/ping", "query": [], "raw": "{{baseUrl}}\/api\/v1\/ping" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "An authenticated no-op for verifying a Data API key end-to-end (auth.api \u2192\nper-plan burst throttle \u2192 monthly quota). It counts against the quota like any\nother call." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"status\":\"ok\",\"plan\":\"free\"}}", "name": "" } ] }, { "name": "Key usage & quota", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/usage", "query": [], "raw": "{{baseUrl}}\/api\/v1\/usage" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Usage introspection for the calling key's owner: the Data API plan, its monthly\nlimit, used and remaining (always matching the X-Quota-* headers), the current\nperiod window, and per-endpoint \/ per-token breakdowns. Embed-widget usage has\nits own plan and pool \u2014 it never appears here." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"plan\":\"free\",\"limit\":10000,\"used\":29,\"remaining\":9971,\"period_start\":\"2026-06-15\",\"period_end\":\"2026-07-15T00:00:00+00:00\",\"burst_per_minute\":60,\"endpoints\":[{\"endpoint\":\"GET api\/v1\/prices\",\"requests\":18},{\"endpoint\":\"GET api\/v1\/global\",\"requests\":11}],\"tokens\":[{\"id\":12,\"name\":\"production\",\"kind\":\"data-api\",\"requests\":29,\"last_used_at\":\"2026-07-02T21:14:09+00:00\",\"revoked\":false}]},\"meta\":{\"note\":\"Endpoint and token breakdowns are flushed from the buffer every minute and can trail `used` slightly.\"}}", "name": "" } ] } ] } ], "auth": { "type": "bearer", "bearer": [ { "key": "Authorization", "type": "string" } ] } }