Quickstart

The DIGIRARE API provides market data and trading for Counterparty collectibles on Bitcoin. Public data needs no API key or wallet. Trading uses an address session and transactions signed by your wallet or local signer.

Make your first request

Requests use https://api.digirare.com/v1 on Bitcoin mainnet. The examples below set API to the origin and include /v1 in each request path.

export API=https://api.digirare.com
curl -sS "$API/v1/assets/RAREPEPE/book"

This reads an asset’s order book. It does not create an order or spend bitcoin. The response wraps the book in result:

Field	What it contains
result.asks	Asking prices and the quantity available at each price
result.listings	Individual listings, including seller, outpoint, and price
result.offers	Offers any holder of the asset can fill
result.direct_offers	Offers on one specific unit (target_txid, target_vout)
result.fills	Recent trades

An asset can have many editions. Use its canonical Counterparty ID, such as RAREPEPE or a numeric asset ID, in requests. A subasset’s display name (asset_longname) is not its API identifier.

Explore the market

curl -sS "$API/v1/collections"
curl -sS "$API/v1/collections/rare-pepe/assets?limit=20"
curl -sS "$API/v1/fills?collection=rare-pepe&limit=20"
curl -sS "$API/v1/analytics"

See Market data for filtering, pagination, and the difference between offer counts and funded buying capacity.

Connect a signer when you are ready to trade

You need two separate capabilities:

1. A session: sign a login message to prove control of your address. Send the returned token in x-session-token on authenticated requests.
2. A transaction signer: review an unsigned PSBT, sign the specified inputs locally, and return the signed PSBT. A session token cannot sign or spend.

There is no API-key application and no minimum balance to sign in. Follow Authentication to create a session. Use a Native SegWit (bc1q…) or Taproot (bc1p…) trading address; your asset source and delivery address can be different. Private keys and seed phrases stay with your signer.

Choose a workflow

You want to…	Start here
Buy available units at a maximum price	Buying
Sell a unit you own	Listing
Bid on specific units or a collection	Offers
Track your orders and confirmations	Events
Resume after an interrupted trade	Recovery
Check public SDK availability	SDK — coming soon

Each trading guide identifies the prerequisites, signing instructions, and submission steps. An unsigned quote does not reserve inventory. Review the price, fees, destination, and inputs before signing.

Request conventions

• Send JSON bodies with Content-Type: application/json.
• BTC amounts are integer satoshis. Raw asset quantities are decimal strings.
• Paged responses include next_cursor; pass it back unchanged as cursor with the same filters until it is null.
• Errors contain code and error. Use code in application logic; the human-readable message can change.
• On 429, wait for Retry-After. After a write times out, check its status before submitting again.

The API reference contains request and response schemas. Download OpenAPI for client generation, or use llms.txt and llms-full.txt with a coding assistant.