Forex Currency Prices Javascript API Documentation

Provides a list of forex price quotes for a given forex currency pair and timeframe.

API Class:

ForexApi

Instance Method:

getForexPrices()

Stock Price Code Example

Use my API Key

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
var intrinioSDK = require('intrinio-sdk');
intrinioSDK.ApiClient.instance.authentications['ApiKeyAuth'].apiKey = "YOUR_API_KEY";
intrinioSDK.ApiClient.instance.enableRetries = true;
var forex = new intrinioSDK.ForexApi();
var pair = "EURUSD";
var timeframe = "D1";
var opts = { 
  'timezone': "UTC",
  'startDate': new Date("2018-01-01"),
  'startTime': null,
  'endDate': new Date("2019-01-01"),
  'endTime': null,
  'pageSize': 100,
  'nextPage': null
};
forex.getForexPrices(pair, timeframe, opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});
הההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההה
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Parameters

Name	Type	Description	Notes
pair	String	The Forex Currency Pair code
timeframe	String	The time interval for the quotes
timezone	String	Returns trading times in this timezone	[optional] [default to UTC]
startDate	Date	Return Forex Prices on or after this date	[optional]
startTime	String	Return Forex Prices at or after this time (24-hour in ‘hh:mm' format, UTC timezone)	[optional]
endDate	Date	Return Forex Prices on or before this date	[optional]
endTime	String	Return Forex Prices at or before this time (24-hour in ‘hh:mm' format, UTC timezone)	[optional]
pageSize	Number	The number of results to return	[optional] [default to 100]
nextPage	String	Gets the next page of data from a previous API call	[optional]

Return Type

object

ApiResponseForexPrices

Properties

Name	Type	Description
prices	[ForexPrice]
pair	ForexPair	The Forex currency pair for which prices were requested
nextPage	String	The token required to request the next page of the data. If null, no further results are available.

object

ForexPrice

Properties

Name	Type	Description
occurredAt	String	The timestamp of the beginning of the timeframe. The open prices would be at this time, while close prices would be at this time plus the timeframe.
openBid	Number	Open bid
highBid	Number	High bid
lowBid	Number	Low bid
closeBid	Number	Close bid
openAsk	Number	Open ask
highAsk	Number	High ask
lowAsk	Number	Low ask
closeAsk	Number	Close ask
totalTicks	Number	Total ticks

object

ForexPair

Properties

Name	Type	Description
code	String	The common code of the currency pair
baseCurrency	String	The ISO 4217 currency code of the base currency
quoteCurrency	String	The ISO 4217 currency code of the quote currency

Forex Currency Prices

SDKs

API Endpoints

Standardized & As-Reported Financial Statement Data

Company Reference & Metadata

Company News

Insider & Institutional Holdings Data

Upcoming & Historical IPOs

Raw Text Filings

XBRL Searchable Financial Statement Notes

Aggregate Standardized Financial Statement Data by SIC Codes

Economic Data

Security Reference Data

Real-Time Prices

Historical Intraday Prices

Historical End of Day Prices

Technical Indicators

Historical End of Day Index Prices

Reference & Metadata

Holdings

Returns & Analytics