GET
/
offers
/
best-offer

Automatically retrieves a single offer that best matches the user’s trading parameters. This offer is optimized for factors such as merchant availability, competitive rates, and faster completion times, providing a seamless trading experience.

Query Parameters

unitAmount
number
fiatUnitAmount
number
network
string

Blockchain network identifier

tokenSymbol
string
fiatSymbol
string
offerType
string
paymentChannel
string
exemptedMerchants
string[]
prioritizeIp
boolean

Response

200 - application/json
behaviour
enum<string>
required

Offer rate behavior

Available options:
FIXED,
FLEXIBLE
createdAt
string
required

Timestamp field.

editedAt
string
required

Timestamp field.

fiatSymbol
string
required

ISO 4217 code for fiat currency

lockedUnit
number
required

units that has been locked out of the offer total unit

network
string
required

id of network on which the asset is on

offerId
string
required

external offer id

offerType
enum<string>
required
Available options:
ONRAMP,
OFFRAMP
partnerDisplayName
string
required

Partner's display name

partnerLastActiveAt
string
required

Timestamp field.

partnerRating
number
required
paymentMethods
object[]
required
rate
number
required

price rate to buy or sell

status
enum<string>
default:
ACTIVE
required

the current offer status

Available options:
PENDING,
ACTIVE,
OFFLINE,
LOW_BALANCE,
LIMIT_REACHED
tokenSymbol
string
required

symbol of token been sold or bought

totalUnit
number
required

offer total unit in fiat

tradedUnit
number
required

units that has been traded out of the total unit

tradeMaximumLimit
number
required

maximum trade limit

tradeMinimumLimit
number
required

minumum trade limit

updatedAt
string
required

Timestamp field.

userId
string
required

userId of the merchant that created offer

adNote
string

note to be shown to the customer

autoResponseMessage
string

auto response message to be shown to customers

customPayinProvider
string

Provider for custom payin (ONRAMP only)

feeConfig
object
feeConfigs
object[]
flexibleOfferMargin
number

offer margin in percentage allowed for flexible offers

instantPayAccountId
string

Account id of instantpay. Useful especially for onramp payins

instantPayEnabled
boolean
default:
false

Is instant pay enabled for offer

instantPayLimit
number

Max tradeable by instant pay on this add. (In fiat value)

instantPayMinimum
number

minimum tradeable by instant pay on this add. (In fiat value)

isPrivate
boolean

Indicates if an ad should be hidden from the public and treated as a private ad.

isRateHidden
boolean

Indicates if rate is hidden

latestCounterOffer
object
maxTimeout
object
partnerStats
object
paymentChannels
object[]
previewImageUrl
string

preview image url

primaryEscrowAddress
string
rateCap
number

The minimum (for onramp) or maximum (for offramp) rate allowed for this ad if it's a flexible ad

statusReason
string

the reason for the current status - mostly applied to non active or offline status

tradeCriteria
object
tradeRequestBroadcastId
string

trade request broadcast id