OpenAPI\Client\FxaggregatesApi

All URIs are relative to https://api.polygon.io, except if the operation defines another base path.

Method	HTTP request	Description
forexEMA()	GET /v1/indicators/ema/{fxTicker}	Exponential Moving Average (EMA)
forexMACD()	GET /v1/indicators/macd/{fxTicker}	Moving Average Convergence/Divergence (MACD)
forexRSI()	GET /v1/indicators/rsi/{fxTicker}	Relative Strength Index (RSI)
forexSMA()	GET /v1/indicators/sma/{fxTicker}	Simple Moving Average (SMA)
v2AggsGroupedLocaleGlobalMarketFxDateGet()	GET /v2/aggs/grouped/locale/global/market/fx/{date}	Grouped Daily (Bars)
v2AggsTickerForexTickerPrevGet()	GET /v2/aggs/ticker/{forexTicker}/prev	Previous Close
v2AggsTickerForexTickerRangeMultiplierTimespanFromToGet()	GET /v2/aggs/ticker/{forexTicker}/range/{multiplier}/{timespan}/{from}/{to}	Aggregates (Bars)

`forexEMA()`

forexEMA($fx_ticker, $timestamp, $timespan, $adjusted, $window, $series_type, $expand_underlying, $order, $limit, $timestamp_gte, $timestamp_gt, $timestamp_lte, $timestamp_lt): \OpenAPI\Client\Model\CryptoEMA200Response

Exponential Moving Average (EMA)

Get the exponential moving average (EMA) for a ticker symbol over a given time range.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: apiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('apiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('apiKey', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\FxaggregatesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$fx_ticker = C:EURUSD; // string | The ticker symbol for which to get exponential moving average (EMA) data.
$timestamp = 'timestamp_example'; // string | Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp.
$timespan = day; // string | The size of the aggregate time window.
$adjusted = true; // bool | Whether or not the aggregates used to calculate the exponential moving average are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits.
$window = 50; // int | The window size used to calculate the exponential moving average (EMA). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average.
$series_type = close; // string | The price in the aggregate which will be used to calculate the exponential moving average. i.e. 'close' will result in using close prices to  calculate the exponential moving average (EMA).
$expand_underlying = false; // bool | Whether or not to include the aggregates used to calculate this indicator in the response.
$order = desc; // string | The order in which to return the results, ordered by timestamp.
$limit = 10; // int | Limit the number of results returned, default is 10 and max is 5000
$timestamp_gte = 'timestamp_gte_example'; // string | Range by timestamp.
$timestamp_gt = 'timestamp_gt_example'; // string | Range by timestamp.
$timestamp_lte = 'timestamp_lte_example'; // string | Range by timestamp.
$timestamp_lt = 'timestamp_lt_example'; // string | Range by timestamp.

try {
    $result = $apiInstance->forexEMA($fx_ticker, $timestamp, $timespan, $adjusted, $window, $series_type, $expand_underlying, $order, $limit, $timestamp_gte, $timestamp_gt, $timestamp_lte, $timestamp_lt);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FxaggregatesApi->forexEMA: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
fx_ticker	string	The ticker symbol for which to get exponential moving average (EMA) data.
timestamp	string	Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp.	[optional]
timespan	string	The size of the aggregate time window.	[optional] [default to 'day']
adjusted	bool	Whether or not the aggregates used to calculate the exponential moving average are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits.	[optional] [default to true]
window	int	The window size used to calculate the exponential moving average (EMA). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average.	[optional] [default to 50]
series_type	string	The price in the aggregate which will be used to calculate the exponential moving average. i.e. 'close' will result in using close prices to calculate the exponential moving average (EMA).	[optional] [default to 'close']
expand_underlying	bool	Whether or not to include the aggregates used to calculate this indicator in the response.	[optional] [default to false]
order	string	The order in which to return the results, ordered by timestamp.	[optional] [default to 'desc']
limit	int	Limit the number of results returned, default is 10 and max is 5000	[optional] [default to 10]
timestamp_gte	string	Range by timestamp.	[optional]
timestamp_gt	string	Range by timestamp.	[optional]
timestamp_lte	string	Range by timestamp.	[optional]
timestamp_lt	string	Range by timestamp.	[optional]

Return type

\OpenAPI\Client\Model\CryptoEMA200Response

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`forexMACD()`

forexMACD($fx_ticker, $timestamp, $timespan, $adjusted, $short_window, $long_window, $signal_window, $series_type, $expand_underlying, $order, $limit, $timestamp_gte, $timestamp_gt, $timestamp_lte, $timestamp_lt): \OpenAPI\Client\Model\CryptoMACD200Response

Moving Average Convergence/Divergence (MACD)

Get moving average convergence/divergence (MACD) data for a ticker symbol over a given time range.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: apiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('apiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('apiKey', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\FxaggregatesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$fx_ticker = C:EURUSD; // string | The ticker symbol for which to get MACD data.
$timestamp = 'timestamp_example'; // string | Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp.
$timespan = day; // string | The size of the aggregate time window.
$adjusted = true; // bool | Whether or not the aggregates used to calculate the MACD are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits.
$short_window = 12; // int | The short window size used to calculate MACD data.
$long_window = 26; // int | The long window size used to calculate MACD data.
$signal_window = 9; // int | The window size used to calculate the MACD signal line.
$series_type = close; // string | The price in the aggregate which will be used to calculate the MACD. i.e. 'close' will result in using close prices to  calculate the MACD.
$expand_underlying = false; // bool | Whether or not to include the aggregates used to calculate this indicator in the response.
$order = desc; // string | The order in which to return the results, ordered by timestamp.
$limit = 10; // int | Limit the number of results returned, default is 10 and max is 5000
$timestamp_gte = 'timestamp_gte_example'; // string | Range by timestamp.
$timestamp_gt = 'timestamp_gt_example'; // string | Range by timestamp.
$timestamp_lte = 'timestamp_lte_example'; // string | Range by timestamp.
$timestamp_lt = 'timestamp_lt_example'; // string | Range by timestamp.

try {
    $result = $apiInstance->forexMACD($fx_ticker, $timestamp, $timespan, $adjusted, $short_window, $long_window, $signal_window, $series_type, $expand_underlying, $order, $limit, $timestamp_gte, $timestamp_gt, $timestamp_lte, $timestamp_lt);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FxaggregatesApi->forexMACD: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
fx_ticker	string	The ticker symbol for which to get MACD data.
timestamp	string	Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp.	[optional]
timespan	string	The size of the aggregate time window.	[optional] [default to 'day']
adjusted	bool	Whether or not the aggregates used to calculate the MACD are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits.	[optional] [default to true]
short_window	int	The short window size used to calculate MACD data.	[optional] [default to 12]
long_window	int	The long window size used to calculate MACD data.	[optional] [default to 26]
signal_window	int	The window size used to calculate the MACD signal line.	[optional] [default to 9]
series_type	string	The price in the aggregate which will be used to calculate the MACD. i.e. 'close' will result in using close prices to calculate the MACD.	[optional] [default to 'close']
expand_underlying	bool	Whether or not to include the aggregates used to calculate this indicator in the response.	[optional] [default to false]
order	string	The order in which to return the results, ordered by timestamp.	[optional] [default to 'desc']
limit	int	Limit the number of results returned, default is 10 and max is 5000	[optional] [default to 10]
timestamp_gte	string	Range by timestamp.	[optional]
timestamp_gt	string	Range by timestamp.	[optional]
timestamp_lte	string	Range by timestamp.	[optional]
timestamp_lt	string	Range by timestamp.	[optional]

Return type

\OpenAPI\Client\Model\CryptoMACD200Response

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`forexRSI()`

forexRSI($fx_ticker, $timestamp, $timespan, $adjusted, $window, $series_type, $expand_underlying, $order, $limit, $timestamp_gte, $timestamp_gt, $timestamp_lte, $timestamp_lt): \OpenAPI\Client\Model\CryptoRSI200Response

Relative Strength Index (RSI)

Get the relative strength index (RSI) for a ticker symbol over a given time range.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: apiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('apiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('apiKey', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\FxaggregatesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$fx_ticker = C:EURUSD; // string | The ticker symbol for which to get relative strength index (RSI) data.
$timestamp = 'timestamp_example'; // string | Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp.
$timespan = day; // string | The size of the aggregate time window.
$adjusted = true; // bool | Whether or not the aggregates used to calculate the relative strength index are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits.
$window = 14; // int | The window size used to calculate the relative strength index (RSI).
$series_type = close; // string | The price in the aggregate which will be used to calculate the relative strength index. i.e. 'close' will result in using close prices to  calculate the relative strength index (RSI).
$expand_underlying = false; // bool | Whether or not to include the aggregates used to calculate this indicator in the response.
$order = desc; // string | The order in which to return the results, ordered by timestamp.
$limit = 10; // int | Limit the number of results returned, default is 10 and max is 5000
$timestamp_gte = 'timestamp_gte_example'; // string | Range by timestamp.
$timestamp_gt = 'timestamp_gt_example'; // string | Range by timestamp.
$timestamp_lte = 'timestamp_lte_example'; // string | Range by timestamp.
$timestamp_lt = 'timestamp_lt_example'; // string | Range by timestamp.

try {
    $result = $apiInstance->forexRSI($fx_ticker, $timestamp, $timespan, $adjusted, $window, $series_type, $expand_underlying, $order, $limit, $timestamp_gte, $timestamp_gt, $timestamp_lte, $timestamp_lt);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FxaggregatesApi->forexRSI: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
fx_ticker	string	The ticker symbol for which to get relative strength index (RSI) data.
timestamp	string	Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp.	[optional]
timespan	string	The size of the aggregate time window.	[optional] [default to 'day']
adjusted	bool	Whether or not the aggregates used to calculate the relative strength index are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits.	[optional] [default to true]
window	int	The window size used to calculate the relative strength index (RSI).	[optional] [default to 14]
series_type	string	The price in the aggregate which will be used to calculate the relative strength index. i.e. 'close' will result in using close prices to calculate the relative strength index (RSI).	[optional] [default to 'close']
expand_underlying	bool	Whether or not to include the aggregates used to calculate this indicator in the response.	[optional] [default to false]
order	string	The order in which to return the results, ordered by timestamp.	[optional] [default to 'desc']
limit	int	Limit the number of results returned, default is 10 and max is 5000	[optional] [default to 10]
timestamp_gte	string	Range by timestamp.	[optional]
timestamp_gt	string	Range by timestamp.	[optional]
timestamp_lte	string	Range by timestamp.	[optional]
timestamp_lt	string	Range by timestamp.	[optional]

Return type

\OpenAPI\Client\Model\CryptoRSI200Response

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`forexSMA()`

forexSMA($fx_ticker, $timestamp, $timespan, $adjusted, $window, $series_type, $expand_underlying, $order, $limit, $timestamp_gte, $timestamp_gt, $timestamp_lte, $timestamp_lt): \OpenAPI\Client\Model\CryptoSMA200Response

Simple Moving Average (SMA)

Get the simple moving average (SMA) for a ticker symbol over a given time range.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: apiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('apiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('apiKey', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\FxaggregatesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$fx_ticker = C:EURUSD; // string | The ticker symbol for which to get simple moving average (SMA) data.
$timestamp = 'timestamp_example'; // string | Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp.
$timespan = day; // string | The size of the aggregate time window.
$adjusted = true; // bool | Whether or not the aggregates used to calculate the simple moving average are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits.
$window = 50; // int | The window size used to calculate the simple moving average (SMA). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average.
$series_type = close; // string | The price in the aggregate which will be used to calculate the simple moving average. i.e. 'close' will result in using close prices to  calculate the simple moving average (SMA).
$expand_underlying = false; // bool | Whether or not to include the aggregates used to calculate this indicator in the response.
$order = desc; // string | The order in which to return the results, ordered by timestamp.
$limit = 10; // int | Limit the number of results returned, default is 10 and max is 5000
$timestamp_gte = 'timestamp_gte_example'; // string | Range by timestamp.
$timestamp_gt = 'timestamp_gt_example'; // string | Range by timestamp.
$timestamp_lte = 'timestamp_lte_example'; // string | Range by timestamp.
$timestamp_lt = 'timestamp_lt_example'; // string | Range by timestamp.

try {
    $result = $apiInstance->forexSMA($fx_ticker, $timestamp, $timespan, $adjusted, $window, $series_type, $expand_underlying, $order, $limit, $timestamp_gte, $timestamp_gt, $timestamp_lte, $timestamp_lt);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FxaggregatesApi->forexSMA: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
fx_ticker	string	The ticker symbol for which to get simple moving average (SMA) data.
timestamp	string	Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp.	[optional]
timespan	string	The size of the aggregate time window.	[optional] [default to 'day']
adjusted	bool	Whether or not the aggregates used to calculate the simple moving average are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits.	[optional] [default to true]
window	int	The window size used to calculate the simple moving average (SMA). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average.	[optional] [default to 50]
series_type	string	The price in the aggregate which will be used to calculate the simple moving average. i.e. 'close' will result in using close prices to calculate the simple moving average (SMA).	[optional] [default to 'close']
expand_underlying	bool	Whether or not to include the aggregates used to calculate this indicator in the response.	[optional] [default to false]
order	string	The order in which to return the results, ordered by timestamp.	[optional] [default to 'desc']
limit	int	Limit the number of results returned, default is 10 and max is 5000	[optional] [default to 10]
timestamp_gte	string	Range by timestamp.	[optional]
timestamp_gt	string	Range by timestamp.	[optional]
timestamp_lte	string	Range by timestamp.	[optional]
timestamp_lt	string	Range by timestamp.	[optional]

Return type

\OpenAPI\Client\Model\CryptoSMA200Response

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`v2AggsGroupedLocaleGlobalMarketFxDateGet()`

v2AggsGroupedLocaleGlobalMarketFxDateGet($date, $adjusted): \OpenAPI\Client\Model\V2AggsGroupedLocaleGlobalMarketCryptoDateGet200Response

Grouped Daily (Bars)

Get the daily open, high, low, and close (OHLC) for the entire forex markets.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: apiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('apiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('apiKey', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\FxaggregatesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$date = 2023-01-09; // string | The beginning date for the aggregate window.
$adjusted = true; // bool | Whether or not the results are adjusted for splits.  By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits.

try {
    $result = $apiInstance->v2AggsGroupedLocaleGlobalMarketFxDateGet($date, $adjusted);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FxaggregatesApi->v2AggsGroupedLocaleGlobalMarketFxDateGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
date	string	The beginning date for the aggregate window.
adjusted	bool	Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits.	[optional]

Return type

\OpenAPI\Client\Model\V2AggsGroupedLocaleGlobalMarketCryptoDateGet200Response

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`v2AggsTickerForexTickerPrevGet()`

v2AggsTickerForexTickerPrevGet($forex_ticker, $adjusted): \OpenAPI\Client\Model\V2AggsTickerCryptoTickerPrevGet200Response

Previous Close

Get the previous day's open, high, low, and close (OHLC) for the specified forex pair.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: apiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('apiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('apiKey', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\FxaggregatesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$forex_ticker = C:EURUSD; // string | The ticker symbol of the currency pair.
$adjusted = true; // bool | Whether or not the results are adjusted for splits.  By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits.

try {
    $result = $apiInstance->v2AggsTickerForexTickerPrevGet($forex_ticker, $adjusted);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FxaggregatesApi->v2AggsTickerForexTickerPrevGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
forex_ticker	string	The ticker symbol of the currency pair.
adjusted	bool	Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits.	[optional]

Return type

\OpenAPI\Client\Model\V2AggsTickerCryptoTickerPrevGet200Response

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`v2AggsTickerForexTickerRangeMultiplierTimespanFromToGet()`

v2AggsTickerForexTickerRangeMultiplierTimespanFromToGet($forex_ticker, $multiplier, $timespan, $from, $to, $adjusted, $sort, $limit): \OpenAPI\Client\Model\V2AggsTickerCryptoTickerRangeMultiplierTimespanFromToGet200Response

Aggregates (Bars)

Get aggregate bars for a forex pair over a given date range in custom time window sizes.

For example, if timespan = ‘minute’ and multiplier = ‘5’ then 5-minute bars will be returned.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: apiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('apiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('apiKey', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\FxaggregatesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$forex_ticker = C:EURUSD; // string | The ticker symbol of the currency pair.
$multiplier = 1; // int | The size of the timespan multiplier.
$timespan = day; // string | The size of the time window.
$from = 2023-01-09; // string | The start of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp.
$to = 2023-01-09; // string | The end of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp.
$adjusted = true; // bool | Whether or not the results are adjusted for splits.  By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits.
$sort = asc; // string | Sort the results by timestamp. `asc` will return results in ascending order (oldest at the top), `desc` will return results in descending order (newest at the top).
$limit = 120; // int | Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000. Read more about how limit is used to calculate aggregate results in our article on <a href=\"https://polygon.io/blog/aggs-api-updates/\" target=\"_blank\" alt=\"Aggregate Data API Improvements\">Aggregate Data API Improvements</a>.

try {
    $result = $apiInstance->v2AggsTickerForexTickerRangeMultiplierTimespanFromToGet($forex_ticker, $multiplier, $timespan, $from, $to, $adjusted, $sort, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FxaggregatesApi->v2AggsTickerForexTickerRangeMultiplierTimespanFromToGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
forex_ticker	string	The ticker symbol of the currency pair.
multiplier	int	The size of the timespan multiplier.
timespan	string	The size of the time window.
from	string	The start of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp.
to	string	The end of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp.
adjusted	bool	Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits.	[optional]
sort	string	Sort the results by timestamp. `asc` will return results in ascending order (oldest at the top), `desc` will return results in descending order (newest at the top).	[optional]
limit	int	Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000. Read more about how limit is used to calculate aggregate results in our article on <a href="https://polygon.io/blog/aggs-api-updates/\" target="_blank" alt="Aggregate Data API Improvements">Aggregate Data API Improvements</a>.	[optional]

Return type

\OpenAPI\Client\Model\V2AggsTickerCryptoTickerRangeMultiplierTimespanFromToGet200Response

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

FxaggregatesApi.md

Latest commit

History

FxaggregatesApi.md

File metadata and controls

OpenAPI\Client\FxaggregatesApi

forexEMA()

Example

Parameters

Return type

Authorization

HTTP request headers

forexMACD()

Example

Parameters

Return type

Authorization

HTTP request headers

forexRSI()

Example

Parameters

Return type

Authorization

HTTP request headers

forexSMA()

Example

Parameters

Return type

Authorization

HTTP request headers

v2AggsGroupedLocaleGlobalMarketFxDateGet()

Example

Parameters

Return type

Authorization

HTTP request headers

v2AggsTickerForexTickerPrevGet()

Example

Parameters

Return type

Authorization

HTTP request headers

v2AggsTickerForexTickerRangeMultiplierTimespanFromToGet()

Example

Parameters

Return type

Authorization

HTTP request headers

`forexEMA()`

`forexMACD()`

`forexRSI()`

`forexSMA()`

`v2AggsGroupedLocaleGlobalMarketFxDateGet()`

`v2AggsTickerForexTickerPrevGet()`

`v2AggsTickerForexTickerRangeMultiplierTimespanFromToGet()`