Skip to content

Collection offers on an asset

GET
/v1/assets/{asset}/policy-offers
curl --request GET \
--url https://api.digirare.com/v1/assets/example/policy-offers

Live policy offers this asset matches (asset scope plus collection/trait policies of its curated collections), best price first, each with an estimated seller net at the current fee rate. Every policy-offer route answers 503 service_unavailable when collection-offer signing is unavailable.

asset
required

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

string

Canonical compact Counterparty asset ID, never a subasset longname.

Policy offers

Media typeapplication/json
object
result
required
Array<object>
object
protocol_version
required
Allowed value: funded_policy_offer_v1
parent_txid
required
string
/^[0-9a-f]{64}$/
funding_slot_id
required

:; alternatives sharing it are mutually exclusive.

string
bidder
required

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

string
kind
required
string
Allowed values: asset collection trait
price_sats
required
integer
>= 1 <= 9007199254740991
offer_value_sats
required
integer
>= 1 <= 9007199254740991
expires_at
required
integer
parent_vsize
required
integer
<= 1000
parent_fee_sats
integer
<= 329
created_at
integer
scope
required
string
Allowed values: asset collection
asset
string | null
collection
string | null
max_supply_units
integer | null
min_supply_units
integer | null
issued_year
integer | null
series
integer | null
artist
string | null
estimate

Estimated seller take at the current fee rate (P2TR seller and fee outputs, 330-sat asset UTXO). A quote, not a promise.

object
fee_rate
number
>= 0.1 <= 500
child_vsize
integer
package_vsize
integer
network_fee_sats
integer
>= 1 <= 9007199254740991
platform_fee_sats
integer
>= 1 <= 9007199254740991
seller_net_sats
integer
acceptable
boolean
status

Bidder history only.

string
Allowed values: active expired pending filled superseded cancelled invalid
market_key_exposure_sats

Bidder history only: the market key can execute up to this while the funding inputs and anchor are unspent.

integer
key
additional properties
any
result_count
integer
next_cursor
string | null
Example
{
"result": [
{
"protocol_version": "funded_policy_offer_v1",
"kind": "asset",
"scope": "asset",
"status": "active"
}
]
}

Stable machine-readable failure

Media typeapplication/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"
}

Stable machine-readable failure

Media typeapplication/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"
}