Skip to content

Latest commit

 

History

History
130 lines (88 loc) · 6.32 KB

README.md

File metadata and controls

130 lines (88 loc) · 6.32 KB
Raw

NCFX

4.2.2 v3

This document was generated automatically. Please see README Generator for more info.

Environment Variables

Required? Name Description Type Options Default
API_USERNAME Username for the NCFX Crypto API string
API_PASSWORD Password for the NCFX Crypto API string
FOREX_WS_API_KEY API key for Forex websocket endpoint string
WS_API_ENDPOINT The WS API endpoint to use for the crypto endpoint string wss://cryptofeed.ws.newchangefx.com
FOREX_WS_API_ENDPOINT The WS API endpoint to use for the forex endpoint string wss://fiat.ws.newchangefx.com/sub/fiat/ws/ref
MARKET_STATUS_WS_API_ENDPOINT The WS API endpoint to use for the market status endpoint string wss://fiat.ws.newchangefx.com/general/reference/v1/markethours
MARKET_STATUS_WS_API_KEY The WS API key to use for the market status endpoint string

Data Provider Rate Limits

There are no rate limits for this adapter.

Input Parameters

Required? Name Description Type Options Default
endpoint The endpoint to use string crypto-lwba, crypto, crypto_lwba, cryptolwba, forex-market-status, forex, market-status, metals-market-status, price crypto

Crypto Endpoint

Supported names for this endpoint are: crypto, price.

Input Params

Required? Name Aliases Description Type Options Default Depends On Not Valid With
✅ base coin, from The symbol of symbols of the currency to query string
✅ quote market, to The symbol of the currency to convert to string

Example

Request:

{
  "data": {
    "endpoint": "crypto",
    "base": "ETH",
    "quote": "USD"
  }
}

Forex Endpoint

forex is the only supported name for this endpoint.

Input Params

Required? Name Aliases Description Type Options Default Depends On Not Valid With
✅ base coin, from The symbol of symbols of the currency to query string
✅ quote market, to The symbol of the currency to convert to string

Example

Request:

{
  "data": {
    "endpoint": "forex",
    "base": "CAD",
    "quote": "USD"
  }
}

Crypto-lwba Endpoint

Supported names for this endpoint are: crypto-lwba, crypto_lwba, cryptolwba.

Input Params

Required? Name Aliases Description Type Options Default Depends On Not Valid With
✅ base coin, from The symbol of symbols of the currency to query string
✅ quote market, to The symbol of the currency to convert to string

Example

Request:

{
  "data": {
    "endpoint": "crypto-lwba",
    "base": "ETH",
    "quote": "USD"
  }
}

Market-status Endpoint

Supported names for this endpoint are: forex-market-status, market-status, metals-market-status.

Input Params

Required? Name Aliases Description Type Options Default Depends On Not Valid With
✅ market The name of the market string forex, metals

Example

There are no examples for this endpoint.

MIT License