5.0.0 • Published 5 years ago

@datafire/nfusionsolutions_biz v5.0.0

Weekly downloads
1
License
MIT
Repository
github
Last release
5 years ago

@datafire/nfusionsolutions_biz

Client library for nFusion Solutions Market Data API v1

Installation and Usage

npm install --save @datafire/nfusionsolutions_biz
let nfusionsolutions_biz = require('@datafire/nfusionsolutions_biz').create();

.then(data => {
  console.log(data);
});

Description

nFusion Solutions provides REST APIs that deliver enterprise-grade financial data. Data sets include real-time and historical pricing for Spot prices of precious metals such as Gold, Silver, Platinum, and Palladium, exchange rates for major currency pairs, exchange rates for Crypto Currencies such as BTC, ETH, and LTC. All API access requires authentication. In order to be issued access credentials you must first enter into a service agreement with nFusion Solutions and acquire a commercial license. For information on how to obtain a licence take a tour of our products or email sales@nfusionsolutions.com.

Actions

api.vversion.Currencies.history.get

Historical OHLC data for the specified period and interval size

The combination of the interval parameter and start and end dates can result in results being truncated to conform to result size limits. See comments on interval parameter for details on valid interval values.

nfusionsolutions_biz.api.vversion.Currencies.history.get({
  "token": "",
  "pairs": "",
  "start": "",
  "version": ""
}, context)

Input

  • input object
    • token required string: auth token
    • pairs required string: comma separated list of currency pairs. For example: USD/CAD,USD/EUR,USD/AUD
    • start required string: start date of time period. format is yyyy-mm-dd
    • end string: end date of time period. format is yyyy-mm-dd. Default is current date.
    • interval string: aggregation interval. Composed of an optional integer value (which defaults to 1 when not specified),
    • format string (values: json, xml): to override content negotiation specify a value of json or xml
    • version required string: The requested API version

Output

api.vversion.Currencies.history.supported.get

Only the currency pairs in the direction noted can be used with the history endpoint. For example: USD/CAD is not the same as CAD/USD

nfusionsolutions_biz.api.vversion.Currencies.history.supported.get({
  "token": "",
  "version": ""
}, context)

Input

  • input object
    • token required string: auth token
    • format string (values: json, xml): to override content negotiation specify a value of json or xml
    • version required string: The requested API version

Output

  • output array
    • items string

api.vversion.Currencies.rate.get

Current Mid Rate

nfusionsolutions_biz.api.vversion.Currencies.rate.get({
  "token": "",
  "pairs": "",
  "version": ""
}, context)

Input

  • input object
    • token required string: auth token
    • pairs required string: comma separated list of currency pairs. For example: USD/CAD,USD/EUR,USD/AUD
    • format string (values: json, xml): to override content negotiation specify a value of json or xml
    • version required string: The requested API version

Output

api.vversion.Currencies.rate.supported.get

Any of the currencies in this list can be paired with any other currency in this list when supplied to the Rate endpoint. For example: USD/CAD,CAD/USD,USD/EUR,EUR/CAD

nfusionsolutions_biz.api.vversion.Currencies.rate.supported.get({
  "token": "",
  "version": ""
}, context)

Input

  • input object
    • token required string: auth token
    • format string (values: json, xml): to override content negotiation specify a value of json or xml
    • version required string: The requested API version

Output

  • output array
    • items string

api.vversion.Currencies.summary.get

Current and daily summary information combined into a single quote

nfusionsolutions_biz.api.vversion.Currencies.summary.get({
  "token": "",
  "pairs": "",
  "version": ""
}, context)

Input

  • input object
    • token required string: auth token
    • pairs required string: comma separated list of currency pairs. For example: USD/CAD,USD/EUR,USD/AUD
    • format string (values: json, xml): to override content negotiation specify a value of json or xml
    • version required string: The requested API version

Output

api.vversion.Currencies.summary.supported.get

Only the currency pairs in the direction noted can be used with the Summary endpoint. For example: USD/CAD is not the same as CAD/USD

nfusionsolutions_biz.api.vversion.Currencies.summary.supported.get({
  "token": "",
  "version": ""
}, context)

Input

  • input object
    • token required string: auth token
    • format string (values: json, xml): to override content negotiation specify a value of json or xml
    • version required string: The requested API version

Output

  • output array
    • items string

api.vversion.Metals.benchmark.history.get

Historical OHLC data for the specified period and interval size

The combination of the interval parameter and start and end dates can result in results being truncated to conform to result size limits. See comments on interval parameter for details on valid interval values.

The historicalfx flag is used to determine whether to apply today's fx rates to a historical period, or to apply the historical rates from that same time frame.

nfusionsolutions_biz.api.vversion.Metals.benchmark.history.get({
  "token": "",
  "metals": "",
  "start": "",
  "version": ""
}, context)

Input

  • input object
    • token required string: auth token
    • metals required string: comma separated list of metals
    • start required string: start date of time period. format is yyyy-mm-dd
    • end string: end date of time period. format is yyyy-mm-dd. Default is current date.
    • interval string: aggregation interval. Composed of an optional integer value (which defaults to 1 when not specified),
    • historicalfx boolean: if true use historical currency rates otherwise current currency rates. Defaults to true.
    • currency string: comma separated list of conversion currencies, defaults to USD
    • unitofmeasure string (values: mg, g, kg, gr, oz, toz, ct, dwt): unit of meaure, defaults to troy ounces. allowed values are:
    • format string (values: json, xml): to override content negotiation specify a value of json or xml
    • version required string: The requested API version

Output

api.vversion.Metals.benchmark.summary.get

Benchmark price information

nfusionsolutions_biz.api.vversion.Metals.benchmark.summary.get({
  "token": "",
  "metals": "",
  "version": ""
}, context)

Input

  • input object
    • token required string: auth token
    • metals required string: comma separated list of metals
    • currency string: comma separated list of conversion currencies, defaults to USD
    • unitofmeasure string (values: mg, g, kg, gr, oz, toz, ct, dwt): unit of meaure, defaults to troy ounces. allowed values are:
    • format string (values: json, xml): to override content negotiation specify a value of json or xml
    • version required string: The requested API version

Output

api.vversion.Metals.benchmark.supported.get

Get list of symbols supported by the benchmark endpoints

nfusionsolutions_biz.api.vversion.Metals.benchmark.supported.get({
  "token": "",
  "version": ""
}, context)

Input

  • input object
    • token required string: auth token
    • format string (values: json, xml): to override content negotiation specify a value of json or xml
    • version required string: The requested API version

Output

  • output array
    • items string

api.vversion.Metals.spot.history.get

Historical OHLC data for the specified period and interval size

The combination of the interval parameter and start and end dates can result in results being truncated to conform to result size limits. See comments on interval parameter for details on valid interval values.

The historicalfx flag is used to determine whether to apply today's fx rates to a historical period, or to apply the historical rates from that same time frame.

nfusionsolutions_biz.api.vversion.Metals.spot.history.get({
  "token": "",
  "metals": "",
  "start": "",
  "version": ""
}, context)

Input

  • input object
    • token required string: auth token
    • metals required string: comma separated list of metals
    • start required string: start date of time period. format is yyyy-mm-dd
    • end string: end date of time period. format is yyyy-mm-dd. Default is current date.
    • interval string: aggregation interval. Composed of an optional integer value (which defaults to 1 when not specified),
    • historicalfx boolean: if true use historical currency rates otherwise current currency rates. Defaults to true.
    • currency string: comma separated list of conversion currencies, defaults to USD
    • unitofmeasure string (values: mg, g, kg, gr, oz, toz, ct, dwt): unit of meaure, defaults to troy ounces. allowed values are:
    • format string (values: json, xml): to override content negotiation specify a value of json or xml
    • version required string: The requested API version

Output

api.vversion.Metals.spot.performance.get

Historical Performance information

nfusionsolutions_biz.api.vversion.Metals.spot.performance.get({
  "token": "",
  "metals": "",
  "version": ""
}, context)

Input

  • input object
    • token required string: auth token
    • metals required string: comma separated list of metals
    • currency string: comma separated list of conversion currencies, defaults to USD
    • unitofmeasure string (values: mg, g, kg, gr, oz, toz, ct, dwt): unit of meaure, defaults to troy ounces. allowed values are:
    • format string (values: json, xml): to override content negotiation specify a value of json or xml
    • version required string: The requested API version

Output

api.vversion.Metals.spot.performance.annual.get

Annual Historical Performance information

nfusionsolutions_biz.api.vversion.Metals.spot.performance.annual.get({
  "token": "",
  "metals": "",
  "version": ""
}, context)

Input

  • input object
    • token required string: auth token
    • metals required string: comma separated list of metals
    • currency string: comma separated list of conversion currencies, defaults to USD
    • unitofmeasure string (values: mg, g, kg, gr, oz, toz, ct, dwt): unit of meaure, defaults to troy ounces. allowed values are:
    • format string (values: json, xml): to override content negotiation specify a value of json or xml
    • years integer: Number of years of history to return. Defaults to 10.
    • version required string: The requested API version

Output

api.vversion.Metals.spot.ratio.history.get

Historical data for the specified period and interval size

The combination of the interval parameter and start and end dates can result in results being truncated to conform to result size limits. See comments on interval parameter for details on valid interval values.

nfusionsolutions_biz.api.vversion.Metals.spot.ratio.history.get({
  "token": "",
  "pairs": "",
  "start": "",
  "version": ""
}, context)

Input

  • input object
    • token required string: auth token
    • pairs required string: comma separated list of metals
    • start required string: start date of time period. format is yyyy-mm-dd
    • end string: end date of time period. format is yyyy-mm-dd. Default is current date.
    • interval string: aggregation interval. Composed of an optional integer value (which defaults to 1 when not specified),
    • format string (values: json, xml): to override content negotiation specify a value of json or xml
    • version required string: The requested API version

Output

api.vversion.Metals.spot.ratio.summary.get

Ratios between prices of two metals

nfusionsolutions_biz.api.vversion.Metals.spot.ratio.summary.get({
  "token": "",
  "pairs": "",
  "version": ""
}, context)

Input

  • input object
    • token required string: auth token
    • pairs required string: comma separated list of metal pairs. For example: gold/silver,gold/platinum,silver/palladium
    • format string (values: json, xml): to override content negotiation specify a value of json or xml
    • version required string: The requested API version

Output

api.vversion.Metals.spot.summary.get

Current and daily summary information combined into a single quote

nfusionsolutions_biz.api.vversion.Metals.spot.summary.get({
  "token": "",
  "metals": "",
  "version": ""
}, context)

Input

  • input object
    • token required string: auth token
    • metals required string: comma separated list of metals
    • currency string: comma separated list of conversion currencies, defaults to USD
    • unitofmeasure string (values: mg, g, kg, gr, oz, toz, ct, dwt): unit of meaure, defaults to troy ounces. allowed values are:
    • format string (values: json, xml): to override content negotiation specify a value of json or xml
    • version required string: The requested API version

Output

api.vversion.Metals.spot.supported.get

Get list of symbols supported by the spot endpoints

nfusionsolutions_biz.api.vversion.Metals.spot.supported.get({
  "token": "",
  "version": ""
}, context)

Input

  • input object
    • token required string: auth token
    • format string (values: json, xml): to override content negotiation specify a value of json or xml
    • version required string: The requested API version

Output

  • output array
    • items string

api.vversion.Metals.supported.currency.get

Get list of currencies supported by metals endpoints for currency conversion

nfusionsolutions_biz.api.vversion.Metals.supported.currency.get({
  "token": "",
  "version": ""
}, context)

Input

  • input object
    • token required string: auth token
    • format string (values: json, xml): to override content negotiation specify a value of json or xml
    • version required string: The requested API version

Output

  • output array
    • items string

Definitions

Interval

  • Interval object
    • change number
    • changePercent number
    • end string
    • high number
    • last number
    • low number
    • open number
    • start string

IntervalCollection

  • IntervalCollection object
    • baseCurrency string
    • intervals array
    • name string
    • symbol string

IntervalCollectionResponse

  • IntervalCollectionResponse object
    • data IntervalCollection
    • error string
    • requestedCurrency string
    • requestedSymbol string
    • requestedUnitOfMeasure string
    • success boolean

ProblemDetails

  • ProblemDetails object
    • detail string
    • instance string
    • status integer
    • title string
    • type string

Rate

  • Rate object
    • symbol string
    • timestamp string
    • value number

RateResponse

  • RateResponse object
    • data Rate
    • error string
    • requestedCurrency string
    • requestedSymbol string
    • requestedUnitOfMeasure string
    • success boolean

ResponseFormat

  • ResponseFormat string (values: json, xml)

Summary

  • Summary object
    • ask number
    • baseCurrency string
    • bid number
    • fiftyTwoWeekHigh number
    • fiftyTwoWeekLow number
    • fiftyTwoWeekPercentChange number
    • fourWeekPercentChange number
    • high number
    • last number
    • low number
    • oneDayChange number
    • oneDayPercentChange number
    • oneDayValue number
    • open number
    • symbol string
    • timeStamp string
    • twelveWeekPercentChange number
    • yearToDatePercentChange number

SummaryResponse

  • SummaryResponse object
    • data Summary
    • error string
    • requestedCurrency string
    • requestedSymbol string
    • requestedUnitOfMeasure string
    • success boolean

UnitOfMeasure

  • UnitOfMeasure string (values: mg, g, kg, gr, oz, toz, ct, dwt)
datafire
@everything-registry/sub-chunk-222@infinitebrahmanuniverse/nolb-_datafire_n@zalastax/nolb-_datafire_n
5.0.0

5 years ago

4.0.0

7 years ago

3.0.0

7 years ago

2.0.0

8 years ago