Connect APIs
Connect API Endpoints
- Trade Options
- Offers
- Orders
- Users
- Business Profile
Get Matching Offers
Searches for, and returns offers that match specified criteria, such as token, fiat, and payment method, enabling users to choose their preferred trade.
Query Parameters
Blockchain network identifier
Strictly match offers created for network or not
Response
Offer rate behavior
FIXED
, FLEXIBLE
Timestamp field.
Timestamp field.
ISO 4217 code for fiat currency
units that has been locked out of the offer total unit
id of network on which the asset is on
external offer id
ONRAMP
, OFFRAMP
Partner's display name
Timestamp field.
price rate to buy or sell
the current offer status
PENDING
, ACTIVE
, OFFLINE
, LOW_BALANCE
, LIMIT_REACHED
symbol of token been sold or bought
offer total unit in fiat
units that has been traded out of the total unit
maximum trade limit
minumum trade limit
Timestamp field.
userId of the merchant that created offer
note to be shown to the customer
auto response message to be shown to customers
Provider for custom payin (ONRAMP only)
Flat fee that must be paid for irrespective of percentage fee
The network this config should be applied to(There will always be at least
one fee config, that config will have network value of default
Fee described as a percentage of the trade
Maximum value a fee is allowed to have
P2P
, IP
, OTC
ONRAMP
, OFFRAMP
Flat fee that must be paid for irrespective of percentage fee
The network this config should be applied to(There will always be at least
one fee config, that config will have network value of default
Fee described as a percentage of the trade
Maximum value a fee is allowed to have
P2P
, IP
, OTC
ONRAMP
, OFFRAMP
offer margin in percentage allowed for flexible offers
Account id of instantpay. Useful especially for onramp payins
Is instant pay enabled for offer
Max tradeable by instant pay on this add. (In fiat value)
minimum tradeable by instant pay on this add. (In fiat value)
Indicates if an ad should be hidden from the public and treated as a private ad.
Indicates if rate is hidden
Timestamp field.
Timestamp field.
additional message
related offer id
userId of other user on the created counter offer
id of previous counter offer
previous proposed rate
proposed rate
counter offer status
PENDING
, ACCEPTED
, REJECTED
the reason for the current status
trade request broadcast id
Timestamp field.
userId of user that created counter offer
preview image url
The minimum (for onramp) or maximum (for offramp) rate allowed for this ad if it's a flexible ad
the reason for the current status - mostly applied to non active or offline status
trade request broadcast id