Skip to main content
GET
/
exchange
/
api
/
offers
Find offers using trading parameters
curl --request GET \
  --url https://external.dev.onboardpay.co/exchange/api/offers
{
  "offers": [
    {
      "offerId": "<string>",
      "userId": "<string>",
      "network": "<string>",
      "tokenSymbol": "BNB",
      "fiatSymbol": "USD, NGN",
      "offerType": "ONRAMP",
      "behaviour": "FIXED",
      "totalUnit": 5000,
      "tradedUnit": 5000,
      "lockedUnit": 5000,
      "rate": 500,
      "paymentMethods": [
        {
          "channelId": "<string>",
          "channelName": "<string>",
          "channelType": "<string>",
          "color": {
            "bg": "<string>",
            "fg": "<string>"
          },
          "id": "<string>"
        }
      ],
      "status": "ACTIVE",
      "partnerDisplayName": "<string>",
      "partnerRating": -1,
      "tradeMinimumLimit": 123,
      "tradeMaximumLimit": 123,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "editedAt": "2023-11-07T05:31:56Z",
      "partnerLastActiveAt": "2023-11-07T05:31:56Z",
      "maxFiatLimit": 123,
      "availableUnits": 123,
      "rateCap": 500,
      "paymentChannels": [
        {
          "channelId": "<string>",
          "channelName": "<string>",
          "channelType": "<string>",
          "color": {
            "bg": "<string>",
            "fg": "<string>"
          }
        }
      ],
      "flexibleOfferMargin": 10,
      "partnerStats": {
        "partnerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "averageRating": 3,
        "totalTransactions": 123,
        "tradeCount": 123,
        "completionPercentage": 94,
        "averageResponseTime": 5
      },
      "statusReason": "<string>",
      "previewImageUrl": "<string>",
      "maxTimeout": {
        "deposit": 1440,
        "confirmation": 600
      },
      "feeConfig": {
        "base": 123,
        "tradePercentage": 123,
        "network": "<string>",
        "tradeType": "ONRAMP",
        "tradeMode": "P2P",
        "cap": 123
      },
      "feeConfigs": [
        {
          "base": 123,
          "tradePercentage": 123,
          "network": "<string>",
          "tradeType": "ONRAMP",
          "tradeMode": "P2P",
          "cap": 123
        }
      ],
      "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"
      },
      "primaryEscrowAddress": "<string>",
      "fiatTradeMinimumLimit": 123,
      "fiatTradeMaximumLimit": 123,
      "fulfillOrderAs": "BUSINESS",
      "autoRefillEnabled": true,
      "autoRefillConfig": {
        "threshold": 123,
        "amount": 123
      }
    }
  ],
  "orderRequestTradeId": "<string>",
  "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

offerType
enum<string>
Available options:
ONRAMP,
OFFRAMP
token
string
fiat
string
tokenAmount
number
fiatAmount
number
networkId
string

Onboard blockchain network identifier or chain Id e.g Base will be base or 8453 or 0x2105

paymentChannel
string
paymentChannelType
string
merchantId
string
page
number
limit
number

Pagination limit

Response

Success

offers
object[]
required
orderRequestTradeId
string
required
currentPage
number
required
totalPages
number
required
totalCount
number
required
totalPairOffers
number