Your prepared inventory

GET

/v1/address/{address}/inventory/prepared

const url = 'https://api.digirare.com/v1/address/example/inventory/prepared';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.digirare.com/v1/address/example/inventory/prepared

Curated exact one-unit attached outpoints available for listing.

Parameters

Path Parameters

address

required

Mainnet P2TR or P2WPKH address. The SIGNING capability: every signature is verified by reconstructing a BIP-143/BIP-341 witness sighash.

string

Query Parameters

collection

string

/^[a-z0-9][a-z0-9-]{0,99}$/

Optional collection scope. Mutually exclusive with the asset filter.

asset

Canonical compact Counterparty key. A subasset uses its A ID; asset_longname is display metadata.

string

Optional canonical compact Counterparty asset scope. Mutually exclusive with the collection filter.

Responses

200

Successful listPreparedInventory response.

application/json

object

result

required

Array<object>

Attached inventory that can be priced without another attach transaction.

object

asset

required

string

asset_longname

required

string | null

collection

required

string

divisible

required

number

protocol_subtype

required

Global Bitcoin Stamps subtype, independent of collection membership.

string | null

media_kind

required

Any of:

string
null

What an asset’s stored art is, as the CDN serves it: the card derivative presents image and animation; video wants a player; html is an on-chain page for a sandboxed frame; svg is crisp at any size.

string

Allowed values: image animation video html svg

prepared_units

required

number

outpoints

required

Array<object>

One exact one-unit attached outpoint eligible for a listing authorization.

object

txid

required

string

vout

required

number

quantity_raw

required

Counterparty atomic units. A string preserves integers beyond JSON’s safe numeric range; divisibility affects display, never this wire value.

string

/^[0-9]+$/

floor_sats

required

Any of:

integer
null

Integer satoshis, exactly representable as a JSON number. Aggregated historical volume can exceed Bitcoin’s supply, so this is the safe JSON integer ceiling, not a single-transaction spending limit.

integer

<= 9007199254740991

listed

required

number

best_offer_sats

required

Any of:

integer
null

integer

<= 9007199254740991

result_count

required

integer

Example

{
  "result": [
    {
      "media_kind": "image"
    }
  ]
}

5XX

Stable machine-readable failure

application/json

object

error

required

string

code

required

string

Allowed values: invalid_request unsupported_address_type unauthenticated forbidden not_found method_not_allowed state_changed expired invalid_transaction rate_limited internal_error upstream_unavailable service_unavailable checkout_changed target_unavailable signature_invalid template_mismatch mempool_rejected broadcast_unknown conflict_spend duplicate_funding_slot offer_selection_unavailable attached_delivery_single_item_only insufficient_funds insufficient_asset_balance price_below_minimum listing_price_above_maximum counter_price_invalid self_trade offer_capacity_full open_offer_limit policy_offer_refused

retryable

boolean

mempool_policy

On 422 mempool_rejected from a broadcast: which deterministic node policy refused the bytes. Retrying the same bytes fails the same way. fee_floor: re-quote at a higher fee_rate. chain_too_long: too many unconfirmed ancestors; wait for a confirmation, then retry. truc: a version-3 (TRUC) package rule, such as spending an unconfirmed version-3 output; wait for a confirmation, then retry.

string

Allowed values: fee_floor chain_too_long truc dust nonstandard

mempool_reason

The node’s own reject reason, on mempool_rejected (422) and on state_changed (409) when a broadcast lost to a conflicting or replacing spend.

string

wait_for_confirmation

Present and true when mempool_policy is chain_too_long or truc.

boolean

claims_released

On a checkout or accept completion refused as mempool_rejected: the journaled settlement ended and every listing, bid, and asset claim it held was released (its inputs were proven unspent). The quote or accept is replaced; request a new one.

boolean

refused_listings

Batch listing routes only: every refused item. The first sets the status and code.

Array<object>

One refused item in a batch refusal’s refused_listings array. Nothing in the batch was changed.

object

index

required

integer

listing_id

required

string

status

required

integer

code

required

string

error

required

string

key

additional properties

any

retry_after_seconds

On 429 rate_limited: the exact seconds until the oldest counted request leaves the window; a retry then is admitted (also sent as Retry-After). Limited writes are bucketed per route scope in exact sliding 60-second windows: by session address when a valid x-session-token is present, otherwise by IP, with a per-IP ceiling across sessions. Expensive writes: 20, ceiling 120. Signed completions: 120, ceiling 600. Session minting (/auth/*): 60 per IP. A request refused by any bucket is counted by none.

integer

>= 1

key

additional properties

any

Example

{
  "code": "invalid_request",
  "mempool_policy": "fee_floor"
}