Connect APIs
- Introduction
- Authentication
- Trade Options
- Offers
- Orders
- Users
- Business Profile
Get Matching Offers
curl --request GET \
--url https://onboard-external-dev.api.nestcoin.io/offers/match{
"offers": [
{
"offerId": "<string>",
"userId": "<string>",
"network": "<string>",
"tokenSymbol": "BNB",
"fiatSymbol": "USD, NGN",
"offerType": "ONRAMP",
"behaviour": "FIXED",
"totalUnit": 5000,
"tradedUnit": 5000,
"lockedUnit": 5000,
"rate": 500,
"rateCap": 500,
"paymentMethods": [
{
"channelId": "<string>",
"channelName": "<string>",
"channelType": "<string>",
"color": {
"bg": "<string>",
"fg": "<string>"
},
"id": "<string>"
}
],
"paymentChannels": [
{
"channelId": "<string>",
"channelName": "<string>",
"channelType": "<string>",
"color": {
"bg": "<string>",
"fg": "<string>"
}
}
],
"flexibleOfferMargin": 10,
"status": "ACTIVE",
"partnerDisplayName": "<string>",
"partnerRating": -1,
"partnerStats": {
"partnerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"averageRating": 3,
"totalTransactions": 123,
"tradeCount": 123,
"completionPercentage": 94,
"averageResponseTime": 5
},
"statusReason": "<string>",
"tradeMinimumLimit": 123,
"tradeMaximumLimit": 123,
"previewImageUrl": "<string>",
"maxTimeout": {
"deposit": 1440,
"confirmation": 600
},
"feeConfig": {
"tradeType": "ONRAMP",
"tradeMode": "P2P",
"base": 123,
"tradePercentage": 123,
"cap": 123,
"network": "<string>"
},
"feeConfigs": [
{
"tradeType": "ONRAMP",
"tradeMode": "P2P",
"base": 123,
"tradePercentage": 123,
"cap": 123,
"network": "<string>"
}
],
"tradeCriteria": {
"verifiedKyc": true
},
"autoResponseMessage": "<string>",
"adNote": "<string>",
"tradeRequestBroadcastId": "<string>",
"isPrivate": true,
"isRateHidden": true,
"instantPayEnabled": false,
"instantPayLimit": 123,
"instantPayMinimum": 123,
"instantPayAccountId": "<string>",
"customPayinProvider": "<string>",
"latestCounterOffer": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"offerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"otherUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"rate": 500,
"previousCounterRate": 500,
"previousCounterId": "<string>",
"status": "PENDING",
"statusReason": "<string>",
"message": "<string>",
"tradeRequestBroadcastId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"editedAt": "2023-11-07T05:31:56Z",
"partnerLastActiveAt": "2023-11-07T05:31:56Z",
"primaryEscrowAddress": "<string>",
"fiatTradeMinimumLimit": 123,
"fiatTradeMaximumLimit": 123,
"maxFiatLimit": 123,
"availableUnits": 123
}
],
"currentPage": 123,
"totalPages": 123,
"totalCount": 123,
"totalPairOffers": 123
}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
external offer id
userId of the merchant that created offer
id of network on which the asset is on
symbol of token been sold or bought
ISO 4217 code for fiat currency
ONRAMP, OFFRAMP Offer rate behavior
FIXED, FLEXIBLE offer total unit in fiat
units that has been traded out of the total unit
units that has been locked out of the offer total unit
price rate to buy or sell
the current offer status
PENDING, ACTIVE, OFFLINE, LOW_BALANCE, LIMIT_REACHED Partner's display name
minumum trade limit
maximum trade limit
Timestamp field.
Timestamp field.
Timestamp field.
Timestamp field.
Maximum fiat limit consideration available units
Calculated available units when locked and traded units are deducted
The minimum (for onramp) or maximum (for offramp) rate allowed for this ad if it's a flexible ad
offer margin in percentage allowed for flexible offers
the reason for the current status - mostly applied to non active or offline status
preview image url
Flat fee that must be paid for irrespective of percentage fee
Fee described as a percentage of the trade
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
ONRAMP, OFFRAMP P2P, IP, OTC Maximum value a fee is allowed to have
Flat fee that must be paid for irrespective of percentage fee
Fee described as a percentage of the trade
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
ONRAMP, OFFRAMP P2P, IP, OTC Maximum value a fee is allowed to have
auto response message to be shown to customers
note to be shown to the customer
trade request broadcast id
Indicates if an ad should be hidden from the public and treated as a private ad.
Indicates if rate is hidden
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)
Account id of instantpay. Useful especially for onramp payins
Provider for custom payin (ONRAMP only)
related offer id
userId of user that created counter offer
userId of other user on the created counter offer
proposed rate
previous proposed rate
id of previous counter offer
counter offer status
PENDING, ACCEPTED, REJECTED the reason for the current status
additional message
trade request broadcast id
Timestamp field.
Timestamp field.
Timestamp field.
curl --request GET \
--url https://onboard-external-dev.api.nestcoin.io/offers/match{
"offers": [
{
"offerId": "<string>",
"userId": "<string>",
"network": "<string>",
"tokenSymbol": "BNB",
"fiatSymbol": "USD, NGN",
"offerType": "ONRAMP",
"behaviour": "FIXED",
"totalUnit": 5000,
"tradedUnit": 5000,
"lockedUnit": 5000,
"rate": 500,
"rateCap": 500,
"paymentMethods": [
{
"channelId": "<string>",
"channelName": "<string>",
"channelType": "<string>",
"color": {
"bg": "<string>",
"fg": "<string>"
},
"id": "<string>"
}
],
"paymentChannels": [
{
"channelId": "<string>",
"channelName": "<string>",
"channelType": "<string>",
"color": {
"bg": "<string>",
"fg": "<string>"
}
}
],
"flexibleOfferMargin": 10,
"status": "ACTIVE",
"partnerDisplayName": "<string>",
"partnerRating": -1,
"partnerStats": {
"partnerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"averageRating": 3,
"totalTransactions": 123,
"tradeCount": 123,
"completionPercentage": 94,
"averageResponseTime": 5
},
"statusReason": "<string>",
"tradeMinimumLimit": 123,
"tradeMaximumLimit": 123,
"previewImageUrl": "<string>",
"maxTimeout": {
"deposit": 1440,
"confirmation": 600
},
"feeConfig": {
"tradeType": "ONRAMP",
"tradeMode": "P2P",
"base": 123,
"tradePercentage": 123,
"cap": 123,
"network": "<string>"
},
"feeConfigs": [
{
"tradeType": "ONRAMP",
"tradeMode": "P2P",
"base": 123,
"tradePercentage": 123,
"cap": 123,
"network": "<string>"
}
],
"tradeCriteria": {
"verifiedKyc": true
},
"autoResponseMessage": "<string>",
"adNote": "<string>",
"tradeRequestBroadcastId": "<string>",
"isPrivate": true,
"isRateHidden": true,
"instantPayEnabled": false,
"instantPayLimit": 123,
"instantPayMinimum": 123,
"instantPayAccountId": "<string>",
"customPayinProvider": "<string>",
"latestCounterOffer": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"offerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"otherUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"rate": 500,
"previousCounterRate": 500,
"previousCounterId": "<string>",
"status": "PENDING",
"statusReason": "<string>",
"message": "<string>",
"tradeRequestBroadcastId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"editedAt": "2023-11-07T05:31:56Z",
"partnerLastActiveAt": "2023-11-07T05:31:56Z",
"primaryEscrowAddress": "<string>",
"fiatTradeMinimumLimit": 123,
"fiatTradeMaximumLimit": 123,
"maxFiatLimit": 123,
"availableUnits": 123
}
],
"currentPage": 123,
"totalPages": 123,
"totalCount": 123,
"totalPairOffers": 123
}