GET
/
offers
/
match
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

​
unitAmount
number
​
fiatUnitAmount
number
​
network
string

Blockchain network identifier

​
tokenSymbol
string
​
fiatSymbol
string
​
offerType
string
​
paymentChannel
string
​
paymentChannelType
string
​
merchantGroupId
string
​
merchantId
string
​
strict
boolean

Strictly match offers created for network or not

​
hideInstantPay
boolean
​
exemptedMerchants
string[]
​
page
number
​
limit
number

Response

200
application/json

Success

The response is of type object.