### Example Response for Get Runes by Transaction ID - JSON Source: https://ordiscan.com/docs/api/index An example JSON response for the GET /v1/tx/{txid}/runes endpoint. This demonstrates the structure of the data returned, including txid, runestone messages, inputs, and outputs. ```json { "data": { "txid": "2dc8414b21accf4a54421cadaa00166bfa64bb1d5019c99b151897fa0bb71534", "runestone_messages": [ { "rune": "DOGGOTOTHEMOON", "type": "TRANSFER" } ], "inputs": [ { "address": "bc1p2lrqw3cv9vqzsajf677ght7v38hk7rzfjwm2x9mgqqypnfjphywsg5l237", "output": "3691b43e7a679dc4550a2fb69cc90581a3b532847b3d04a45dc3ec78cefb57e9:1826", "rune": "DOGGOTOTHEMOON", "rune_amount": "88980600000" } ], "outputs": [ { "address": "bc1p8r9p0hthz0jsw75m8s34egdnwft5gl5kdvqt6fp07mcfryxetavszefx50", "vout": 0, "rune": "DOGGOTOTHEMOON", "rune_amount": "88980600000" } ] } } ``` -------------------------------- ### Get UTXOs by Address (JSON Response) Source: https://ordiscan.com/docs/api/index Example JSON response structure for the UTXOs endpoint, showing details for each UTXO including its outpoint, value in sats, associated runes (if any), and inscription IDs (if any). This structure helps in parsing the data for applications. ```json { "data": [ { "outpoint": "04295c622b83ffc81036dbfdc9c5b160468fbb5c22e35b45126d6e876b556645:1686", "value": 546, "runes": [ { "name": "DOGGOTOTHEMOON", "balance": "100000000000" } ], "inscriptions": [ "56636ffca4c65b73b46003682d9f8ba10e8af0a8012adebf40f0c849c0b16084i0" ] } // ... ] } ``` -------------------------------- ### GET /v1/brc20 Source: https://context7.com/context7/ordiscan_api/llms.txt Browse all BRC-20 tokens with market prices. ```APIDOC ## GET /v1/brc20 ### Description Browse all BRC-20 tokens with market prices. ### Method GET ### Endpoint /v1/brc20 ### Parameters #### Query Parameters - **sort** (string) - Optional - How to sort the results (e.g., "oldest", "newest"). ### Request Example ```bash curl -G https://api.ordiscan.com/v1/brc20?sort=oldest \ -H "Authorization: Bearer YOUR_API_KEY" ``` ### Response #### Success Response (200) - **data** (array) - An array of BRC-20 tokens. - **tick** (string) - The token ticker symbol. - **max_supply** (integer) - The maximum supply of the token. - **minted** (integer) - The amount of the token minted. - **price** (number) - The current market price of the token. #### Response Example ```json { "data": [ { "tick": "ORDI", "max_supply": 21000000, "minted": 21000000, "price": 33.62 } ] } ``` ``` -------------------------------- ### GET /v1/runes Source: https://context7.com/context7/ordiscan_api/llms.txt Browse all runes with sorting and pagination. ```APIDOC ## GET /v1/runes ### Description Browse all runes with sorting and pagination. ### Method GET ### Endpoint `/v1/runes` ### Parameters #### Path Parameters None #### Query Parameters - **sort** (string) - Optional - Specifies the sorting order. Example: `oldest`. - **limit** (integer) - Optional - The number of results to return per page. - **offset** (integer) - Optional - The number of results to skip. #### Request Body None ### Request Example ```bash curl -G https://api.ordiscan.com/v1/runes?sort=oldest \ -H "Authorization: Bearer YOUR_API_KEY" ``` ### Response #### Success Response (200) - **data** (array) - An array of rune objects. - **id** (string) - The unique identifier for the rune. - **name** (string) - The name of the rune. - **formatted_name** (string) - The rune name with formatting. - **spacers** (integer) - The number of spacers in the rune name. - **number** (integer) - The rune number. - **inscription_id** (string | null) - The ID of the inscription associated with the rune. - **decimals** (integer) - The number of decimal places for the rune. - **mint_count_cap** (string) - The maximum number of mints allowed for the rune. - **symbol** (string) - The symbol representing the rune. - **etching_txid** (string | null) - The transaction ID of the rune's etching. - **amount_per_mint** (string) - The amount of rune minted per transaction. - **timestamp_unix** (integer | null) - The Unix timestamp of the rune's creation. - **premined_supply** (string) - The pre-mined supply of the rune. - **mint_start_block** (integer) - The block height when minting starts. - **mint_end_block** (integer) - The block height when minting ends. #### Response Example ```json { "data": [ { "id": "1:0", "name": "UNCOMMONGOODS", "formatted_name": "UNCOMMON•GOODS", "spacers": 128, "number": 0, "inscription_id": null, "decimals": 0, "mint_count_cap": "340282366920938463463374607431768211455", "symbol": "⧉", "etching_txid": null, "amount_per_mint": "1", "timestamp_unix": null, "premined_supply": "0", "mint_start_block": 840000, "mint_end_block": 1050000 } ] } ``` ``` -------------------------------- ### GET /v1/sat/{sat_number} Source: https://context7.com/context7/ordiscan_api/llms.txt Query information about individual satoshis including satributes. ```APIDOC ## GET /v1/sat/{sat_number} ### Description Query information about individual satoshis including satributes. ### Method GET ### Endpoint /v1/sat/{sat_number} ### Parameters #### Path Parameters - **sat_number** (integer) - Required - The number of the satoshi to query. ### Request Example ```bash curl -G https://api.ordiscan.com/v1/sat/392052419460 \ -H "Authorization: Bearer YOUR_API_KEY" ``` ### Response #### Success Response (200) - **data** (object) - Contains information about the satoshi. - **sat_number** (integer) - The number of the satoshi. - **satributes** (array) - An array of attributes associated with the satoshi. - **creation_date** (string) - The date the satoshi was created. - **block_height** (integer) - The block height at which the satoshi was created. - **epoch** (integer) - The epoch number. - **inscription_ids** (array) - An array of inscription IDs associated with the satoshi. #### Response Example ```json { "data": { "sat_number": 392052419460, "satributes": ["BLOCK_78", "VINTAGE"], "creation_date": "2009-01-04T07:00:05.000Z", "block_height": 78, "epoch": 0, "inscription_ids": [ "e484c48e4571ddd915ce22dfc037a76c1f42ffcef2fad7c8ee816ed87873fd0ci0" ] } } ``` ``` -------------------------------- ### GET /v1/alkane/{id}/meta Source: https://context7.com/context7/ordiscan_api/llms.txt Retrieve contract methods and opcodes for alkanes. ```APIDOC ## GET /v1/alkane/{id}/meta ### Description Retrieve contract methods and opcodes for alkanes. ### Method GET ### Endpoint /v1/alkane/{id}/meta ### Parameters #### Path Parameters - **id** (string) - Required - The ID of the alkane contract. ### Request Example ```bash curl -G https://api.ordiscan.com/v1/alkane/4:2/meta \ -H "Authorization: Bearer YOUR_API_KEY" ``` ### Response #### Success Response (200) - **data** (object) - Contains alkane metadata. - **name** (string) - The name of the alkane. - **methods** (array) - An array of methods available for the alkane. - **name** (string) - The name of the method. - **opcode** (integer) - The opcode associated with the method. - **params** (array) - The parameters the method accepts. - **returns** (string) - The return type of the method. #### Response Example ```json { "data": { "name": "BambooRoll", "methods": [ { "name": "initialize", "opcode": 0, "params": [], "returns": "void" }, { "name": "donate", "opcode": 42, "params": [], "returns": "void" }, { "name": "roll", "opcode": 69, "params": [], "returns": "void" } ] } } ``` ``` -------------------------------- ### GET /v1/alkanes Source: https://context7.com/context7/ordiscan_api/llms.txt Browse alkane tokens, contracts, and NFTs with filtering. ```APIDOC ## GET /v1/alkanes ### Description Browse alkane tokens, contracts, and NFTs with filtering. ### Method GET ### Endpoint `/v1/alkanes` ### Parameters #### Path Parameters None #### Query Parameters - **type** (string) - Optional - Filter by type (e.g., `token`, `contract`, `nft`). - **limit** (integer) - Optional - The number of results to return per page. - **offset** (integer) - Optional - The number of results to skip. #### Request Body None ### Request Example ```bash curl -G https://api.ordiscan.com/v1/alkanes \ -H "Authorization: Bearer YOUR_API_KEY" ``` ### Response #### Success Response (200) - **data** (array) - An array of alkane objects. - **id** (string) - The unique identifier for the alkane. - **name** (string) - The name of the alkane. - **type** (string) - The type of the alkane (e.g., `token`, `contract`, `nft`). - **details** (object) - Specific details depending on the alkane type. #### Response Example ```json { "data": [ { "id": "alkane123", "name": "OrdiToken", "type": "token", "details": { "symbol": "ORDI", "decimals": 8 } }, { "id": "alkane456", "name": "MyNFTCollection", "type": "nft", "details": { "creator": "0xabc...", "max_supply": 10000 } } ] } ``` ``` -------------------------------- ### GET /v1/collection/{slug}/market Source: https://context7.com/context7/ordiscan_api/llms.txt Query floor price and market cap for collections. ```APIDOC ## GET /v1/collection/{slug}/market ### Description Query floor price and market cap for collections. ### Method GET ### Endpoint `/v1/collection/{slug}/market` ### Parameters #### Path Parameters - **slug** (string) - Required - The slug of the collection. #### Query Parameters None #### Request Body None ### Request Example ```bash curl -G https://api.ordiscan.com/v1/collection/bitcoin-puppets/market \ -H "Authorization: Bearer YOUR_API_KEY" ``` ### Response #### Success Response (200) - **data** (object) - An object containing market data for the collection. - **floor_price_in_sats** (integer) - The floor price of the collection in satoshis. - **floor_price_in_usd** (number) - The floor price of the collection in USD. - **market_cap_in_btc** (number) - The market capitalization of the collection in BTC. - **market_cap_in_usd** (number) - The market capitalization of the collection in USD. #### Response Example ```json { "data": { "floor_price_in_sats": 4210950, "floor_price_in_usd": 4972, "market_cap_in_btc": 251.76, "market_cap_in_usd": 29727870 } } ``` ``` -------------------------------- ### GET /v1/runes Source: https://ordiscan.com/docs/api/index Get a list of the latest runes. Limited to 100 per request. Supports sorting and pagination. ```APIDOC ## List Runes ### Description Get a list of the latest runes. Limited to 100 per request. ### Method GET ### Endpoint /v1/runes ### Query Parameters - **sort** (string, optional) - Specify the sorting order for the runes. Can be either `newest` (default) or `oldest`. - **after** (number, optional) - Only return runes etched after a certain rune number. Useful for pagination when the sort order is `oldest`. - **before** (number, optional) - Only return runes etched before a certain rune number. Useful for pagination when the sort order is `newest`. ### Response (Response structure not provided in the input text.) ``` -------------------------------- ### GET /v1/block/{height} Source: https://context7.com/context7/ordiscan_api/llms.txt Retrieve Bitcoin block information and indexing status. ```APIDOC ## GET /v1/block/{height} ### Description Retrieve Bitcoin block information and indexing status. ### Method GET ### Endpoint /v1/block/{height} ### Parameters #### Path Parameters - **height** (integer) - Required - The block height to query. ### Request Example ```bash curl -G https://api.ordiscan.com/v1/block/840000 \ -H "Authorization: Bearer YOUR_API_KEY" ``` ### Response #### Success Response (200) - **data** (object) - Contains block information. - **hash** (string) - The block hash. - **height** (integer) - The block height. - **timestamp** (string) - The block timestamp. - **size** (integer) - The block size in bytes. - **weight** (integer) - The block weight. - **status** (object) - Indexing status for different features. - **runes_indexed** (boolean) - Whether runes are indexed for this block. - **inscriptions_indexed** (boolean) - Whether inscriptions are indexed for this block. #### Response Example ```json { "data": { "hash": "0000000000000000000320283a032748cef8227873ff4872689bf23f1cda83a5", "height": 840000, "timestamp": "2024-04-19T23:09:27.000Z", "size": 2325617, "weight": 3993281, "status": { "runes_indexed": true, "inscriptions_indexed": true } } } ``` ``` -------------------------------- ### GET /v1/inscription/{inscription_id}/activity Source: https://ordiscan.com/docs/api/index Get the list of transfers for a specific inscription. Limited to 20 per page. Supports pagination. ```APIDOC ## Transfer Activity ### Description Get the list of transfers for a specific inscription. Limited to 20 per page. ### Method GET ### Endpoint /v1/inscription/{inscription_id}/activity ### Path Parameters - **inscription_id** (string) - The inscription ID (e.g. `b61b0172d95e266c18aea0c624db987e971a5d6d4ebc2aaed85da4642d635735i0`) ### Query Parameters - **page** (number, optional) - Used to retrieve the next page of activity (e.g. `?page=2`). ### Response #### Success Response (200) - **data** (array) - A list of inscription transfer objects. - **from_address** (string) - The address the inscription was transferred from. - **to_address** (string) - The address the inscription was transferred to. - **inscription_id** (string) - The ID of the inscription. - **spent_as_fee** (boolean) - Whether the inscription was spent as a fee. - **txid** (string) - The transaction ID of the transfer. - **confirmed** (boolean) - Whether the transfer is confirmed. - **timestamp** (string) - The timestamp of the transfer. ### Request Example ```curl curl -G https://api.ordiscan.com/v1/inscription/26482871f33f1051f450f2da9af275794c0b5f1c61ebf35e4467fb42c2813403i0/activity \ -H "Authorization: Bearer {your-api-key}" ``` ### Response Example ```json { "data": [ { "from_address": "bc1p77u6q4lfq60qgkslyf7z3j0dwxnmuqkljzlvgl4sxyh40pa87njq2k4eul", "to_address": "bc1pdrm7tcyk4k6c3cdcjwkp49jmfrwmtvt0dvqyy7y4qp79tgks4lmqdpj6rw", "inscription_id": "26482871f33f1051f450f2da9af275794c0b5f1c61ebf35e4467fb42c2813403i0", "spent_as_fee": false, "txid": "5fddcbdc3eb21a93e8dd1dd3f9087c3677f422b82d5ba39a6b1ec37338154af6", "confirmed": true, "timestamp": "2023-03-03T23:19:50.000Z" } ] } ``` ``` -------------------------------- ### GET /v1/rune/{rune_name}/market Source: https://context7.com/context7/ordiscan_api/llms.txt Query current price and market cap for runes. ```APIDOC ## GET /v1/rune/{rune_name}/market ### Description Query current price and market cap for runes. ### Method GET ### Endpoint `/v1/rune/{rune_name}/market` ### Parameters #### Path Parameters - **rune_name** (string) - Required - The name of the rune. #### Query Parameters None #### Request Body None ### Request Example ```bash curl -G https://api.ordiscan.com/v1/rune/DOGGOTOTHEMOON/market \ -H "Authorization: Bearer YOUR_API_KEY" ``` ### Response #### Success Response (200) - **data** (object) - An object containing market data. - **price_in_sats** (number) - The price of the rune in satoshis. - **price_in_usd** (number) - The price of the rune in USD. - **market_cap_in_btc** (number) - The market capitalization of the rune in BTC. - **market_cap_in_usd** (number) - The market capitalization of the rune in USD. #### Response Example ```json { "data": { "price_in_sats": 4.15, "price_in_usd": 0.002529, "market_cap_in_btc": 4150, "market_cap_in_usd": 252851200 } } ``` ``` -------------------------------- ### GET /v1/address/{bitcoin-address}/utxos Source: https://ordiscan.com/docs/api/index Fetches all UTXOs for a given Bitcoin address, including associated inscriptions and runes. ```APIDOC ## GET /v1/address/{bitcoin-address}/utxos ### Description Get all UTXOs owned by a Bitcoin address and the inscriptions and runes tied to them (if they have any). ### Method GET ### Endpoint `/v1/address/{bitcoin-address}/utxos` ### Parameters #### Path Parameters - **bitcoin-address** (string) - Required - A valid Bitcoin address. ### Request Example ```bash curl -G https://api.ordiscan.com/v1/address/bc1pr8vjq0fk89f5sw3r4n9scrasvw7kaud9akhzw57c3ygycsjspvvseyjcma/utxos \ -H "Authorization: Bearer {your-api-key}" ``` ### Response #### Success Response (200) - **data** (array) - An array of UTXO objects. - **outpoint** (string) - The unique outpoint, in the format `{txid}:{vout}`. - **value** (number) - The value in sats. - **runes** (array) - A list of rune balances. - **inscriptions** (array) - A list of inscription IDs. #### Response Example ```json { "data": [ { "outpoint": "04295c622b83ffc81036dbfdc9c5b160468fbb5c22e35b45126d6e876b556645:1686", "value": 546, "runes": [ { "name": "DOGGOTOTHEMOON", "balance": "100000000000" } ], "inscriptions": [ "56636ffca4c65b73b46003682d9f8ba10e8af0a8012adebf40f0c849c0b16084i0" ] } ] } ``` ``` -------------------------------- ### GET /v1/rune-name/{name} Source: https://context7.com/context7/ordiscan_api/llms.txt Verify when a rune name becomes available to etch. ```APIDOC ## GET /v1/rune-name/{name} ### Description Verify when a rune name becomes available to etch. ### Method GET ### Endpoint `/v1/rune-name/{name}` ### Parameters #### Path Parameters - **name** (string) - Required - The name of the rune to check. #### Query Parameters None #### Request Body None ### Request Example ```bash curl -G https://api.ordiscan.com/v1/rune-name/HELLO \ -H "Authorization: Bearer YOUR_API_KEY" ``` ### Response #### Success Response (200) - **data** (object) - An object containing rune name availability details. - **name** (string) - The name of the rune. - **status** (string) - The current status of the rune name (e.g., `LOCKED`, `AVAILABLE`). - **unlock_block_height** (integer | null) - The block height at which the rune name will be available. - **unlock_block_timestamp** (string | null) - The timestamp at which the rune name will be available. #### Response Example ```json { "data": { "name": "HELLO", "status": "LOCKED", "unlock_block_height": 975173, "unlock_block_timestamp": "2026-11-14T23:15:07.000Z" } } ``` ``` -------------------------------- ### GET /v1/rune/{rune_name} Source: https://context7.com/context7/ordiscan_api/llms.txt Retrieve detailed rune information including current supply. ```APIDOC ## GET /v1/rune/{rune_name} ### Description Retrieve detailed rune information including current supply. ### Method GET ### Endpoint `/v1/rune/{rune_name}` ### Parameters #### Path Parameters - **rune_name** (string) - Required - The name of the rune. #### Query Parameters None #### Request Body None ### Request Example ```bash curl -G https://api.ordiscan.com/v1/rune/UNCOMMONGOODS \ -H "Authorization: Bearer YOUR_API_KEY" ``` ### Response #### Success Response (200) - **data** (object) - An object containing rune details. - **id** (string) - The unique identifier for the rune. - **name** (string) - The name of the rune. - **formatted_name** (string) - The rune name with formatting. - **spacers** (integer) - The number of spacers in the rune name. - **number** (integer) - The rune number. - **inscription_id** (string | null) - The ID of the inscription associated with the rune. - **decimals** (integer) - The number of decimal places for the rune. - **mint_count_cap** (string) - The maximum number of mints allowed for the rune. - **symbol** (string) - The symbol representing the rune. - **etching_txid** (string | null) - The transaction ID of the rune's etching. - **amount_per_mint** (string) - The amount of rune minted per transaction. - **timestamp_unix** (integer | null) - The Unix timestamp of the rune's creation. - **premined_amount** (string) - The pre-mined amount of the rune. - **mint_start_block** (integer) - The block height when minting starts. - **mint_end_block** (integer) - The block height when minting ends. - **current_supply** (string) - The current supply of the rune. - **current_mint_count** (integer) - The current number of mints for the rune. #### Response Example ```json { "data": { "id": "1:0", "name": "UNCOMMONGOODS", "formatted_name": "UNCOMMON•GOODS", "spacers": 128, "number": 0, "inscription_id": null, "decimals": 0, "mint_count_cap": "340282366920938463463374607431768211455", "symbol": "⧉", "etching_txid": null, "amount_per_mint": "1", "timestamp_unix": null, "premined_amount": "0", "mint_start_block": 840000, "mint_end_block": 1050000, "current_supply": "0", "current_mint_count": 0 } } ``` ``` -------------------------------- ### Get Inscription by ID (curl) Source: https://ordiscan.com/docs/api/index Retrieves information about a specific inscription using its unique ID. This example demonstrates a direct curl request, requiring an API key for authorization. The response contains details of the requested inscription. ```curl curl -G https://api.ordiscan.com/v1/inscription/{inscription_id} \ -H "Authorization: Bearer {your-api-key}" ``` -------------------------------- ### Get Sat Ranges for UTXO Source: https://ordiscan.com/docs/api/index Retrieves all sat ranges for a given Bitcoin UTXO, irrespective of whether they contain rare sats. Requires an API key for authorization. Returns an array of ranges, where each range is defined by an inclusive start and exclusive end number. ```curl curl -G https://api.ordiscan.com/v1/utxo/3d57f76284e17370f1ce45e75f68b5960906c4117951607f20ddd19f85c15706:0/sat-ranges \ -H "Authorization: Bearer {your-api-key}" ``` ```json { "data": [ [ 740078609838558, 740078609848558 ] ] } ``` -------------------------------- ### Fetch Rune Market Info - API Source: https://ordiscan.com/docs/api/index Retrieves the current market information for a specific rune, including its price in sats and USD, and its market capitalization in BTC and USD. This endpoint requires an API key. ```Shell curl -G https://api.ordiscan.com/v1/rune/DOGGOTOTHEMOON/market \ -H "Authorization: Bearer {your-api-key}" ``` ```JSON { "data": { "price_in_sats": 4.15, "price_in_usd": 0.002529, "market_cap_in_btc": 4150, "market_cap_in_usd": 252851200 } } ``` -------------------------------- ### Get Owned Inscriptions by Address (JSON Response) Source: https://ordiscan.com/docs/api/index Example JSON response for the 'Owned inscriptions' endpoint. It details an inscription object, including its ID, number, content type, owner and genesis addresses, timestamp, metadata, and any associated BRC-20 actions. This provides comprehensive data for each inscription. ```json { "data": [ { "inscription_id": "b61b0172d95e266c18aea0c624db987e971a5d6d4ebc2aaed85da4642d635735i0", "inscription_number": 348020, "content_type": "text/plain;charset=utf-8", "owner_address": "bc1pxaneaf3w4d27hl2y93fuft2xk6m4u3wc4rafevc6slgd7f5tq2dqyfgy06", "owner_output": "b61b0172d95e266c18aea0c624db987e971a5d6d4ebc2aaed85da4642d635735:0", "genesis_address": "bc1pxaneaf3w4d27hl2y93fuft2xk6m4u3wc4rafevc6slgd7f5tq2dqyfgy06", "genesis_output": "b61b0172d95e266c18aea0c624db987e971a5d6d4ebc2aaed85da4642d635735:0", "timestamp": "2023-03-08T04:16:31.000Z", "metadata": null, "metaprotocol": null, "sat": 923155354107609, "content_url": "https://ordiscan.com/content/b61b0172d95e266c18aea0c624db987e971a5d6d4ebc2aaed85da4642d635735i0", "parent_inscription_id": null, "delegate_inscription_id": null, "satributes": [], "submodules": [], "brc20_action": { "type": "DEPLOY", "tick": "ORDI" } }, { // ... } ] } ``` -------------------------------- ### Fetch All Runes (cURL) Source: https://ordiscan.com/docs/api/index Demonstrates how to fetch all etched runes using cURL. This command-line tool allows for easy interaction with the Ordiscan API, enabling sorting by the 'oldest' parameter. ```bash curl -G https://api.ordiscan.com/v1/runes?sort=oldest \ -H "Authorization: Bearer {your-api-key}" ``` -------------------------------- ### Get Owned Inscription IDs by Address (JSON Response) Source: https://ordiscan.com/docs/api/index Example JSON response for the 'Owned inscription IDs' endpoint. It provides a direct array of inscription IDs (strings) owned by the queried Bitcoin address. This is useful for quickly checking ownership without retrieving full inscription details. ```json { "data": [ "c0ca691ee80a67be1d91fc910de3b9e93b07688eb06bc1d3941ea67e30626e25i0", "93a2fede93c39eb42c83365eeafbc0fef437b47a40b1470c17234b1bfbf45a14i0", "49c681ce2854e27355ef819710e6613c31f0db44641b8f4d0bf2b26942d79b36i0", // ... ] } ``` -------------------------------- ### GET /v1/alkane/{alkane-id} Source: https://ordiscan.com/docs/api/index Get detailed information about a specific alkane by its ID. ```APIDOC ## GET /v1/alkane/{alkane-id} ### Description Get detailed information about a specific alkane by its ID. Returns the same data as the list endpoint, plus `current_supply` and `current_mint_count`. ### Method GET ### Endpoint /v1/alkane/{alkane-id} ### Parameters #### Path Parameters - **alkane-id** (string) - Required - The unique alkane identifier (e.g., "2:42"). ### Request Example ```bash curl -G https://api.ordiscan.com/v1/alkane/2:42 \ -H "Authorization: Bearer {your-api-key}" ``` ### Response #### Success Response (200) - **current_supply** (string) - The current total supply. - **current_mint_count** (number) - The current number of mints that have occurred. (Includes all fields from the list alkanes response) #### Response Example ```json { "data": { "id": "2:42", "name": "MyToken", "symbol": "MTK", "logo_url": "https://cdn.ordiscan.com/alkanes/2_42", "type": "TOKEN", "premined_supply": "0", "amount_per_mint": "1000", "mint_count_cap": "21000", "current_supply": "5000000", "current_mint_count": 5000, "deploy_txid": "abc123...", "deploy_timestamp": "2024-01-15T10:30:00.000Z" } } ``` ``` -------------------------------- ### GET /v1/tx/{txid}/inscriptions Source: https://ordiscan.com/docs/api/index Get all the new inscriptions created from a specific Bitcoin transaction. ```APIDOC ## GET /v1/tx/{txid}/inscriptions ### Description Get all the new inscriptions created from a specific Bitcoin transaction. ### Method GET ### Endpoint /v1/tx/{txid}/inscriptions ### Parameters #### Path Parameters - **txid** (string) - Required - The transaction ID (txid) (e.g. `7d0a2dd897222913d58fc957b0429526117a0a61c964642fe93b077f328ccec1`). #### Query Parameters None #### Request Body None ### Request Example (No example provided in the source text) ### Response #### Success Response (200) (Response structure not fully detailed in the source text. Expected to be an array of inscription objects.) #### Response Example (No example provided in the source text) ``` -------------------------------- ### GET /v1/alkane/{id}/meta Source: https://ordiscan.com/docs/api/index Get the contract metadata for a specific alkane, including available opcodes. ```APIDOC ## GET /v1/alkane/{id}/meta ### Description Get the contract metadata for a specific alkane, including what opcodes are available to call. ### Method GET ### Endpoint /v1/alkane/{id}/meta ### Parameters #### Path Parameters - **id** (string) - Required - The unique alkane identifier (e.g., "2:42"). ### Request Example (No specific request example provided in the source text, but would follow the pattern of other alkane endpoints) ### Response #### Success Response (200) (The response structure for metadata is not detailed in the provided text.) ``` -------------------------------- ### GET /v1/alkanes Source: https://ordiscan.com/docs/api/index Get a list of alkanes. Limited to 100 per request. Supports filtering and sorting. ```APIDOC ## GET /v1/alkanes ### Description Get a list of alkanes. Limited to 100 per request. Supports filtering and sorting. ### Method GET ### Endpoint /v1/alkanes ### Parameters #### Query Parameters - **sort** (string) - Optional - Specify the sorting order for the alkanes. Can be either `newest` (default) or `oldest`. - **type** (string) - Optional - Filter by alkane type. Can be one of: `TOKEN`, `CONTRACT`, `NFT_COLLECTION`, `NFT_ITEM`. - **page** (number) - Optional - Page number for pagination (defaults to 1). ### Request Example ```bash curl -G https://api.ordiscan.com/v1/alkanes \ -H "Authorization: Bearer {your-api-key}" ``` ### Response #### Success Response (200) An array of objects with the following keys: - **id** (string) - The unique identifier of the alkane. - **name** (string | null) - The name of the alkane (if available). - **symbol** (string | null) - The symbol of the alkane (if available). - **type** (string) - The type of alkane (`TOKEN`, `CONTRACT`, `NFT_COLLECTION`, or `NFT_ITEM`). - **logo_url** (string | null) - The CDN URL for the alkane's icon image (if available). - **premined_supply** (string) - The premined supply amount. - **amount_per_mint** (string | null) - The amount minted per mint operation (if applicable). - **mint_count_cap** (string | null) - The maximum number of mints allowed (if applicable). - **deploy_txid** (string | null) - The transaction ID where the alkane was deployed. - **deploy_timestamp** (string | null) - The ISO timestamp when the alkane was deployed. #### Response Example ```json { "data": [ { "id": "2:42", "name": "MyToken", "symbol": "MTK", "logo_url": "https://cdn.ordiscan.com/alkanes/2_42", "type": "TOKEN", "premined_supply": "0", "amount_per_mint": "1000", "mint_count_cap": "21000", "deploy_txid": "abc123...", "deploy_timestamp": "2024-01-15T10:30:00.000Z" } ] } ``` ``` -------------------------------- ### Get Sat Info Source: https://context7.com/context7/ordiscan_api/llms.txt Queries information about individual satoshis, including their attributes, creation date, and associated inscription IDs. This endpoint requires an API key for authorization. The response provides comprehensive details for a given satoshi number. ```bash curl -G https://api.ordiscan.com/v1/sat/392052419460 \ -H "Authorization: Bearer YOUR_API_KEY" ``` -------------------------------- ### List BRC-20 Tokens Source: https://ordiscan.com/docs/api/index Fetches a list of the latest BRC-20 tokens, with options to sort by newest or oldest and paginate results. Limited to 20 tokens per page. Requires an API key. ```javascript GET /v1/brc20 ``` ```shell curl -G https://api.ordiscan.com/v1/brc20?sort=oldest \ -H "Authorization: Bearer {your-api-key}" ``` -------------------------------- ### GET /v1/address/{bitcoin-address}/activity/brc20 Source: https://ordiscan.com/docs/api/index Retrieves the BRC-20 activity for a given Bitcoin address. This includes transfer, mint, and deploy operations. ```APIDOC ## GET /v1/address/{bitcoin-address}/activity/brc20 ### Description Retrieves the BRC-20 activity for a given Bitcoin address. This includes transfer, mint, and deploy operations. ### Method GET ### Endpoint /v1/address/{bitcoin-address}/activity/brc20 ### Parameters #### Path Parameters - **bitcoin-address** (string) - Required - The Bitcoin address to query activity for. #### Query Parameters None #### Request Body None ### Request Example ```curl curl -G https://api.ordiscan.com/v1/address/bc1pxaneaf3w4d27hl2y93fuft2xk6m4u3wc4rafevc6slgd7f5tq2dqyfgy06/activity/brc20 \ -H "Authorization: Bearer {your-api-key}" ``` ### Response #### Success Response (200) - **data** (array) - An array of BRC-20 transaction objects. - **ticker** (string) - The BRC-20 ticker (4 or 5 characters). - **type** (string) - Can be `TRANSFER`, `MINT` or `DEPLOY`. - **from_address** (string | null) - Address sending the token. - **to_address** (string | null) - Address receiving the token. - **amount** (number) - The amount of tokens sent. - **inscription_id** (string) - The inscription ID associated with the BRC-20 transaction. - **timestamp** (string) - A datetime string for when the BRC-20 inscription was created. #### Response Example ```json { "data": [ { "ticker": "DOMO", "type": "TRANSFER", "from_address": "bc1pquadyenr7r40g4ud53lhuajxwz3pjye62pgpvdpkv449l5cs9ftq0qh3a7", "to_address": "bc1pxaneaf3w4d27hl2y93fuft2xk6m4u3wc4rafevc6slgd7f5tq2dqyfgy06", "amount": 1000, "inscription_id": "dbc5e8525e7b6332b1af2e30d1f199f15dcca45dc6bae2d97182c0f33ea01a50i0", "timestamp": "2023-11-07T22:12:50.246Z" }, { "ticker": "DOMO", "type": "MINT", "from_address": null, "to_address": "bc1pxaneaf3w4d27hl2y93fuft2xk6m4u3wc4rafevc6slgd7f5tq2dqyfgy06", "amount": 1000, "inscription_id": "2a81948ab1d860d555bc87d418f5c55314b473cf76b24c8a2f64a8fed9a3b91ci0", "timestamp": "2023-10-05T12:12:50.246Z" } ] } ``` ``` -------------------------------- ### List BRC-20 Tokens Source: https://context7.com/context7/ordiscan_api/llms.txt Browses all available BRC-20 tokens, including their market prices. This endpoint requires an API key for access and can be sorted by oldest issuance. The response provides a list of tokens with their tick symbol, maximum supply, minted amount, and current price. ```bash curl -G https://api.ordiscan.com/v1/brc20?sort=oldest \ -H "Authorization: Bearer YOUR_API_KEY" ```