{"openapi":"3.1.0","info":{"title":"UniSat (BYOK) API","version":"0.1.0","description":"UniSat (BYOK) lets an AI assistant read your own UniSat data through the UniSat API with a key you supply (UniSat API key (free plan: 5 calls per second, 2,000 per day)). Read-only: 11 tools (get_blockchain_info, get_address_balance, get_address_history, get_transaction, list_block_transactions, get_inscription_info, list_inscription_events, list_brc20_tickers, get_brc20_info, list_brc20_holders,...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-unisat.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-unisat/docs"},"termsOfService":"https://connectorbay.com/byok-unisat/terms"},"servers":[{"url":"https://byok-unisat.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-unisat/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/get_blockchain_info":{"post":{"operationId":"get_blockchain_info","summary":"Get the Bitcoin chain state seen by UniSat: chain, block height, header height, best block hash, median time and chainwo","description":"Get the Bitcoin chain state seen by UniSat: chain, block height, header height, best block hash, median time and chainwork. Use for \"What is the current Bitcoin block height on UniSat\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"get_blockchain_infoArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_address_balance":{"post":{"operationId":"get_address_balance","summary":"Get a Bitcoin address balance in satoshis, split into plain BTC and satoshis held in inscriptions, with UTXO counts and ","description":"Get a Bitcoin address balance in satoshis, split into plain BTC and satoshis held in inscriptions, with UTXO counts and pending amounts. Use for \"What is the balance of this Bitcoin address\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"address":{"description":"Bitcoin address.","maxLength":100,"title":"Address","type":"string"}},"required":["address"],"title":"get_address_balanceArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_address_history":{"post":{"operationId":"get_address_history","summary":"List the transactions of a Bitcoin address, with ids, input and output totals, height, confirmations and time. Use for \"","description":"List the transactions of a Bitcoin address, with ids, input and output totals, height, confirmations and time. Use for \"What are the latest transactions of this Bitcoin address\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"address":{"description":"Bitcoin address.","maxLength":100,"title":"Address","type":"string"},"cursor":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Start offset for paging (0 for the first page).","title":"Cursor"},"size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"Number of items to return (1 to 100).","title":"Size"}},"required":["address"],"title":"get_address_historyArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_transaction":{"post":{"operationId":"get_transaction","summary":"Get one Bitcoin transaction by id: input and output counts and totals in satoshis, size, block height, confirmations and","description":"Get one Bitcoin transaction by id: input and output counts and totals in satoshis, size, block height, confirmations and time. Use for \"What are the details of this Bitcoin transaction\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"txid":{"description":"Transaction id, 64 hex characters.","maxLength":64,"title":"Txid","type":"string"}},"required":["txid"],"title":"get_transactionArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_block_transactions":{"post":{"operationId":"list_block_transactions","summary":"List the transactions of a Bitcoin block by height, one page at a time. Use for \"Which transactions are in Bitcoin block","description":"List the transactions of a Bitcoin block by height, one page at a time. Use for \"Which transactions are in Bitcoin block 840000\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"height":{"description":"Block height.","minimum":0,"title":"Height","type":"integer"},"cursor":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Start offset for paging (0 for the first page).","title":"Cursor"},"size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"Number of items to return (1 to 100).","title":"Size"}},"required":["height"],"title":"list_block_transactionsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_inscription_info":{"post":{"operationId":"get_inscription_info","summary":"Get an ordinal inscription by id: owner address, content type and length, inscription number, height, time and BRC-20 pa","description":"Get an ordinal inscription by id: owner address, content type and length, inscription number, height, time and BRC-20 payload when present. Use for \"Who owns this ordinal inscription and what is its content type\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"inscription_id":{"description":"Inscription id, the transaction id followed by i and the index.","maxLength":80,"title":"Inscription Id","type":"string"}},"required":["inscription_id"],"title":"get_inscription_infoArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_inscription_events":{"post":{"operationId":"list_inscription_events","summary":"List inscription events (creations and transfers) between two block heights, with inscription id, number, address and tr","description":"List inscription events (creations and transfers) between two block heights, with inscription id, number, address and transaction. Use for \"What inscription events happened in blocks 840000 to 840001\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"start":{"description":"First block height.","minimum":0,"title":"Start","type":"integer"},"end":{"description":"Last block height (0 includes mempool data).","minimum":0,"title":"End","type":"integer"},"cursor":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Start offset for paging (0 for the first page).","title":"Cursor"},"size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"Number of items to return (1 to 100).","title":"Size"}},"required":["start","end"],"title":"list_inscription_eventsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_brc20_tickers":{"post":{"operationId":"list_brc20_tickers","summary":"List BRC-20 token tickers known to the indexer, one page at a time. Use for \"Which BRC-20 tokens exist\".","description":"List BRC-20 token tickers known to the indexer, one page at a time. Use for \"Which BRC-20 tokens exist\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"start":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Start offset for paging (0 for the first page).","title":"Start"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"Number of items to return (1 to 100).","title":"Limit"}},"title":"list_brc20_tickersArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_brc20_info":{"post":{"operationId":"get_brc20_info","summary":"Get one BRC-20 token: creator, max supply, minted amount, mint count, holder count, decimals, limit per mint and deploy ","description":"Get one BRC-20 token: creator, max supply, minted amount, mint count, holder count, decimals, limit per mint and deploy height. Use for \"How many holders does the BRC-20 token ordi have and how much is minted\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"ticker":{"description":"BRC-20 token ticker, for example ordi.","maxLength":20,"title":"Ticker","type":"string"}},"required":["ticker"],"title":"get_brc20_infoArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_brc20_holders":{"post":{"operationId":"list_brc20_holders","summary":"List holders of a BRC-20 token with available, transferable and overall balance, one page at a time. Use for \"Who are th","description":"List holders of a BRC-20 token with available, transferable and overall balance, one page at a time. Use for \"Who are the biggest holders of the BRC-20 token ordi\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"ticker":{"description":"BRC-20 token ticker, for example ordi.","maxLength":20,"title":"Ticker","type":"string"},"start":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Start offset for paging (0 for the first page).","title":"Start"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"Number of items to return (1 to 100).","title":"Limit"}},"required":["ticker"],"title":"list_brc20_holdersArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_address_brc20_summary":{"post":{"operationId":"get_address_brc20_summary","summary":"List the BRC-20 balances of a Bitcoin address with available, transferable and overall amount per ticker. Use for \"Which","description":"List the BRC-20 balances of a Bitcoin address with available, transferable and overall amount per ticker. Use for \"Which BRC-20 tokens does this Bitcoin address hold\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"address":{"description":"Bitcoin address.","maxLength":100,"title":"Address","type":"string"},"start":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Start offset for paging (0 for the first page).","title":"Start"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"Number of items to return (1 to 100).","title":"Limit"}},"required":["address"],"title":"get_address_brc20_summaryArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}