NEnestechops
offers-offers
offers-onboardapi

Get best offer for trade parameters

Changed on
get/offers/best-offer

Request

Query parameters

unitAmountnumber
fiatUnitAmountnumber
networkstring

Blockchain network identifier

tokenSymbolstring
fiatSymbolstring
offerType'ONRAMP' | 'OFFRAMP'
paymentChannelstring
exemptedMerchantsstring[]
prioritizeIpboolean

Response

Success

offerIdstring required

external offer id

userIdstring required

userId of the merchant that created offer

networkstring required

id of network on which the asset is on

tokenSymbolstring required

symbol of token been sold or bought

fiatSymbolstring required

ISO 4217 code for fiat currency

offerType'ONRAMP' | 'OFFRAMP' required
behaviour'FIXED' | 'FLEXIBLE' required

Offer rate behavior

totalUnitnumber required

offer total unit in fiat

tradedUnitnumber required

units that has been traded out of the total unit

lockedUnitnumber required

units that has been locked out of the offer total unit

ratenumber required

price rate to buy or sell

rateCapnumber

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

flexibleOfferMarginnumber

offer margin in percentage allowed for flexible offers

status'PENDING' | 'ACTIVE' | 'OFFLINE' | 'LOW_BALANCE' | 'LIMIT_REACHED' required

the current offer status

partnerDisplayNamestring required

Partner's display name

partnerRatingnumber required
statusReasonstring

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

tradeMinimumLimitnumber required

minimum trade limit

tradeMaximumLimitnumber required

maximum trade limit

previewImageUrlstring

preview image url

autoResponseMessagestring

auto response message to be shown to customers

adNotestring

note to be shown to the customer

tradeRequestBroadcastIdstring

trade request broadcast id

isPrivateboolean

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

isRateHiddenboolean

Indicates if rate is hidden

instantPayEnabledboolean

Is instant pay enabled for offer

instantPayLimitnumber

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

instantPayMinimumnumber

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

instantPayAccountIdstring

Account id of instantpay. Useful especially for onramp payins

customPayinProviderstring

Provider for custom payin (ONRAMP only)

createdAtstring date-time required

Timestamp field.

updatedAtstring date-time required

Timestamp field.

editedAtstring date-time required

Timestamp field.

partnerLastActiveAtstring date-time required

Timestamp field.

primaryEscrowAddressstring
fiatTradeMinimumLimitnumber
fiatTradeMaximumLimitnumber
maxFiatLimitnumber required

Maximum fiat limit consideration available units

availableUnitsnumber required

Calculated available units when locked and traded units are deducted

fulfillOrderAs'BUSINESS' | 'PERSONAL'
autoRefillEnabledboolean

Flag indicating if auto refill is enabled for this ad

Example response

{
  "tokenSymbol": "BNB",
  "fiatSymbol": "USD, NGN",
  "totalUnit": 5000,
  "tradedUnit": 5000,
  "lockedUnit": 5000,
  "rate": 500,
  "rateCap": 500,
  "flexibleOfferMargin": 10,
  "partnerRating": -1,
  "partnerStats": {
    "averageRating": 3,
    "completionPercentage": 94,
    "averageResponseTime": 5
  },
  "maxTimeout": {
    "deposit": 1440,
    "confirmation": 600
  }
}

Changes

  • fc790ea4deb6Revision changes
    • breaking

      the query request parameter offerType was restricted to a list of enum values

    • warning

      removed the optional property from the response with the status

    • info

      api operation id getBestOffer removed and replaced with getBestOfferOffers

    • info

      added the new enum value OFFRAMP to the query request parameter offerType

    • info

      added the new enum value ONRAMP to the query request parameter offerType

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added to the / response property allOf list for the response status

    • info

      removed from the / response property allOf list for the response status