Skip to navigation

Get a market ad

One ad of the book, with the same fields as an item of GET /v1/p2p/ads plus the pair’s network, asset and decimals. Use it to open the order screen from a direct link or after a reload. The advertiser’s wallet and tenant are never returned: to open an order, send your own walletId on the pair’s network. An ad that is not active, whose tenant left the book, or a buy ad whose advertiser is outside their cashout hours or has cashout blocked, is 404 ad_not_found. An ad with no stock left still returns, with availableAmount at zero; price is null while there is no usable quote.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

adIdstringRequired
Ad id.

Headers

X-Tenant-IdstringRequired
Tenant context used for authorization and routing.
X-Request-TimestampstringRequired

Unix seconds. Required on the signed host; tolerance is 300s either way (403 request_timestamp_skew).

X-Content-SHA256stringRequired

Lowercase hex SHA-256 of the body. An empty body hashes the empty string, so the header is always present. Mismatch returns 400 body_hash_mismatch.

X-Request-SignaturestringRequired

Detached JWS (<protected>..<signature>, ES256 or PS256) over METHOD\nPATH?QUERY\nTIMESTAMP\nIDEMPOTENCY_KEY_OR_EMPTY\nX_CONTENT_SHA256.

Response

Ad
adIdstringOptional
Ad identifier.
sideenumOptional
Advertiser side.
Allowed values:
pairstringOptional
Pair code.
priceModeenumOptional

Pricing: spread (bps over the Binance spot), fixed (fixed BRL price) or offset (signed BRL amount, 4 decimal places, over the Binance spot).

Allowed values:
spreadBpsintegerOptional

spread mode: basis points over the Binance spot.

offsetstringOptional

offset mode: signed BRL amount per unit added to the Binance spot, 4 decimal places. Requests may still send the deprecated integer offsetCents; responses only send offset.

pricestring or nullOptional

Current BRL price per unit, 4 decimal places; null without a usable quote.

fixedPricestringOptional

Fixed price per unit, 4 decimal places (owner).

limitsUnitenumOptional

Unit the advertiser set the per-order range in.

Allowed values:
minAmountstringOptional

Minimum BRL per order. With limitsUnit asset it is minAssetAmount at the price shown, so it moves with the price.

maxAmountstringOptional

Maximum BRL per order. With limitsUnit asset it is maxAssetAmount at the price shown.

minAssetAmountstringOptional

Minimum crypto per order. Only with limitsUnit asset.

maxAssetAmountstringOptional

Maximum crypto per order. Only with limitsUnit asset.

availableAmountstringOptional

Crypto available (stock minus reserved).

stockAmountstringOptional

Total stock (owner).

reservedAmountstringOptional

Reserved by open orders (owner).

walletIdstringOptional

Ad wallet (owner).

deliveryDeadlineMinintegerOptional
Minutes to send after both sign.
instructionsstringOptional
Advertiser instructions.
instructionsFlaggedbooleanOptional

Instructions flagged for review (owner).

statusenumOptional
Ad status.
Allowed values:
pausedReasonstringOptional

Why the ad was paused automatically (owner). cashout_locked means the holder blocked the account’s cashout; reactivate after unblocking.

hiddenReasonenumOptional

Owner only, active buy ads: why the market is not showing the ad right now. cashout_locked: cashout blocked; cashout_outside_hours: outside the account’s cashout hours (comes back when the window opens).

Allowed values:
advertiserobjectOptional

Advertiser (market listing).

createdAtdatetime or nullOptional
Creation time.
updatedAtdatetime or nullOptional
Last change.
networkstringOptional
Network of the pair.
assetstringOptional
decimalsintegerOptional
Decimal places of the asset amount.

Errors

403
Forbidden Error
404
Not Found Error