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 exchange-external-api API

The exchange-external-api API from Nestcoin — 13 operation(s) for exchange-external-api.

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

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

This API exposes 14 operations across 13 paths, and defines 48 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.

14 operations 13 paths 48 schemas 13 GET1 POST

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 exchange-external-api 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 14

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

exchange-external-api 14
GET
/exchange/api/info
Get CEX Profile
queryMyBusinessInfo → 200400401500
GET
/exchange/orders/trade
Start a trade
createOrder 13 params → 301400401500
GET
/exchange/api/orders/trade-options
Trade options / configurations for onboard
getTradeOptions → 200400401500
GET
/exchange/api/orders/price
Get best price for order
getPrice 7 params → 200400401500
GET
/exchange/api/orders/trade-url
Fetch trade url
initTrade 13 params → 200400401500
GET
/exchange/api/cexs/signers
Query CEX signer addresses
querySignersExternal → 200400401500
GET
/exchange/api/cexs/signers/{networkId}
Query CEX network signer
queryNetworkSignerExternal 1 param → 200400401500
GET
/exchange/api/cexs/liquidity-pools
Get CEX deployed liquidity pool contract data
queryLiquidityPoolsExternal 1 param → 200400401500
POST
/exchange/api/cexs/liquidity-pools
Create liquidity pool contract for CEX
deployLiquidityPoolExternal body → 201400401500
GET
/exchange/api/cexs/liquidity-pools/{poolAddress}/balances
Get CEX token and coin balances
fetchLiquidityPoolBalanceExternal 2 params → 200400401500
GET
/exchange/api/orders
Retrieve list of exchange orders
getExchangeOrdersExternal 9 params → 200400401500
GET
/exchange/api/business/orders/{cexOrderId}
Retrieve an exchange order by cexOrderId
getExchangeOrderByIdExternal 1 param → 200400401500
GET
/exchange/api/offers
Find offers using trading parameters
extFindOffers 11 params → 200400401500
GET
/exchange/api/offers/best-offer
Get best offer using trade parameters
getBestOfferExchange 7 params → 200400401500

Schemas 48

The contract defines 48 schemas that model the data the API accepts and returns. The most detailed are OfferDto (49 properties), CexProfileDto (31 properties), ExchangeOrderDTO (25 properties), OrderOfferDTO (10 properties). Each schema is shown below with its type and property counts.

DeployLiquidityPoolCommand
object
2 properties 2 required
ErrorMessageDto
object
Default error object for services. This gives consistent error object that all services may use.
3 properties 2 required
ExchangeOrdersResponse
object
5 properties
TradeMode
string
WalletDTO
object
3 properties
InitTradeTradeTypeEnum
string
CexProfileDto
object
CEX user profile object
31 properties 17 required
PartnerStats
object
6 properties
FeeConfig
object
6 properties 3 required
OfferPaymentChannelColor
object
2 properties 2 required
OfferDto
object
49 properties 23 required
OfferType
string
GetExchangeOrdersExternalTransactionTypeEnum
string
PaymentChannel
object
3 properties 1 required
BusinessDirector
object
A current director of the business
2 properties 2 required
LiquidityPoolBalanceDto
object
6 properties 4 required
ExchangeOrderDTO
object
25 properties
DefaultConfigurationResponse
object
2 properties 2 required
OfferStatus
string
the current offer status
CexSignerDto
object
Registered wallet address
5 properties 3 required
LiquidityPoolDto
object
8 properties 5 required
TransactionLimitResponse
object
4 properties
BlockchainNetwork
object
7 properties 6 required
TradeCriteria
object
1 property
UltimateBeneficialOwner
object
An individual owning 25% or more of the business
3 properties 3 required
OfferTypeQueryParamOfferTypeEnum
string
CreateOrderDto
object
Response for a successful create order command
1 property 1 required
BestOfferDTO
object
2 properties 2 required
BusinessDocument
object
An uploaded KYB document
3 properties 2 required
CreateOrderTradeTypeEnum
string
BusinessCategory
string
KYB onboarding tier that determines the required document set
CreateOrderProductEnum
string
TradeOptions
object
4 properties 2 required
AutoRefillConfig
object
2 properties 2 required
LegalEntityType
string
Legal structure of the business entity (KYB "Business type (Entity)")
BusinessIndustry
string
Sector the business primarily operates in
PaymentChannelSupportedCurrency
object
2 properties
GetExchangeOrdersExternalStatusesEnum
string
TradeTypeQueryParamTradeTypeEnum
string
PriceDto
object
Price for a trade
1 property 1 required
OfferPaymentMethod
object
InitTradeProductEnum
string
FiatCurrency
object
6 properties 3 required
OfferBehavior
string
Offer rate behavior
OfferPaymentChannel
object
4 properties
FulfillOrderAs
string
Tokens
object
5 properties 4 required
OrderOfferDTO
object
10 properties 6 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nestcoin-exchange-external-api-api-openapi.yml Raw ↑

Other APIs Nestcoin publishes across the network.

Nestcoin auth-oauth API
Nestcoin auth-userauth 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
Nestcoin offers-offers API