Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Nestcoin offers-offers API

The offers-offers API from Nestcoin — 3 operation(s) for offers-offers.

Nestcoin offers-offers API is one of 23 APIs that Nestcoin publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include offers-offers. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 3 operations across 3 paths, and defines 15 schemas. It is described by OpenAPI 3.0.3, at version 3.0.2.

Requests are made against a single base URL, https://external.dev.onboardpay.co.

3 operations 3 paths 15 schemas 3 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
3.0.2
Base URL
https://external.dev.onboardpay.co
Authentication
API Key, API Key
License
UNLICENSED
Resource Areas
1

Authentication & Security 2

Nestcoin offers-offers API declares 2 security schemes for authenticating requests. An API key is passed in the header as x-signature (authSignature). An API key is passed in the header as x-auth-token (authToken).

  • authToken — Auth Token header for inter-service communication

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 3 GET. Each is listed below with its method, path, parameters, and response codes.

offers-offers 3
GET
/offers/rate
get Weighted Rates
getWeightedRates 3 params → 200400401500
GET
/offers/limits
Find matching offer for trading pair
getLimits 4 params → 200400401500
GET
/offers/best-offer
Get best offer for trade parameters
getBestOfferOffers 9 params → 200400401500

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are OffersSvcOfferDto (49 properties), OfferLimitsDto (8 properties), OffersSvcFeeConfig (6 properties), OffersSvcPartnerStats (6 properties). Each schema is shown below with its type and property counts.

ErrorMessageDto
object
Default error object for services. This gives consistent error object that all services may use.
3 properties 2 required
OffersSvcPartnerStats
object
6 properties
OfferLimitsDto
object
8 properties 4 required
OffersSvcOfferPaymentChannelColor
object
2 properties 2 required
OffersSvcAutoRefillConfig
object
2 properties 2 required
OffersSvcTradeMode
string
OffersSvcOfferPaymentMethod
object
OffersSvcOfferType
string
OffersSvcFulfillOrderAs
string
OffersSvcTradeCriteria
object
1 property
OffersSvcOfferPaymentChannel
object
4 properties
OffersSvcOfferStatus
string
the current offer status
OffersSvcOfferDto
object
49 properties 23 required
OffersSvcOfferBehavior
string
Offer rate behavior
OffersSvcFeeConfig
object
6 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nestcoin-offers-offers-api-openapi.yml Raw ↑

Other APIs Nestcoin publishes across the network.

Nestcoin auth-oauth API
Nestcoin auth-userauth API
Nestcoin exchange-external-api API
Nestcoin exchange-orders API
Nestcoin ledger-account activity API
Nestcoin ledger-accounts API
Nestcoin ledger-beneficiaries API
Nestcoin ledger-cash deposits API
Nestcoin ledger-offramp accounts API
Nestcoin ledger-payments API
Nestcoin ledger-sub-accounts API
Nestcoin ledger-transfer API