Skip to content

Latest commit

 

History

History
131 lines (100 loc) · 5.57 KB

PricesApi.md

File metadata and controls

131 lines (100 loc) · 5.57 KB
Raw

PricesApi

All URIs are relative to https://api.equibles.com

Method HTTP request Description
endOfDay GET /stocks/prices/endofday Lists the end of day prices for a given stock.
intraday GET /stocks/prices/intraday Lists the intraday prices for a given stock with one minute precision.

endOfDay

PricesResponse endOfDay(fullTicker, startTime, endTime, page, pageSize)

Lists the end of day prices for a given stock.

Example

// Import classes:
//import com.equibles.stocks.ApiClient;
//import com.equibles.stocks.ApiException;
//import com.equibles.stocks.Configuration;
//import com.equibles.stocks.auth.*;
//import com.equibles.stocks.api.PricesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: Query String
ApiKeyAuth Query String = (ApiKeyAuth) defaultClient.getAuthentication("Query String");
Query String.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Query String.setApiKeyPrefix("Token");

PricesApi apiInstance = new PricesApi();
String fullTicker = "fullTicker_example"; // String | The fully qualified ticker of the stock. Example: AAPL.XNAS
OffsetDateTime startTime = new OffsetDateTime(); // OffsetDateTime | The start time of the window. UTC time formatted according to ISO 8601 (i.e: 2022-02-01T13:45:17)
OffsetDateTime endTime = new OffsetDateTime(); // OffsetDateTime | The end time of the window. UTC time formatted according to ISO 8601 (i.e: 2022-02-01T13:45:17)
Integer page = 1; // Integer | The number of the page to request.
Integer pageSize = 1000; // Integer | The number of elements in each page. Max value: 50000.
try {
    PricesResponse result = apiInstance.endOfDay(fullTicker, startTime, endTime, page, pageSize);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PricesApi#endOfDay");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
fullTicker String The fully qualified ticker of the stock. Example: AAPL.XNAS
startTime OffsetDateTime The start time of the window. UTC time formatted according to ISO 8601 (i.e: 2022-02-01T13:45:17) [optional]
endTime OffsetDateTime The end time of the window. UTC time formatted according to ISO 8601 (i.e: 2022-02-01T13:45:17) [optional]
page Integer The number of the page to request. [optional] [default to 1]
pageSize Integer The number of elements in each page. Max value: 50000. [optional] [default to 1000]

Return type

PricesResponse

Authorization

[Query String](../README.md#Query String)

HTTP request headers

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

intraday

PricesResponse intraday(fullTicker, startTime, endTime, page, pageSize)

Lists the intraday prices for a given stock with one minute precision.

Example

// Import classes:
//import com.equibles.stocks.ApiClient;
//import com.equibles.stocks.ApiException;
//import com.equibles.stocks.Configuration;
//import com.equibles.stocks.auth.*;
//import com.equibles.stocks.api.PricesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: Query String
ApiKeyAuth Query String = (ApiKeyAuth) defaultClient.getAuthentication("Query String");
Query String.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Query String.setApiKeyPrefix("Token");

PricesApi apiInstance = new PricesApi();
String fullTicker = "fullTicker_example"; // String | The fully qualified ticker of the stock. Example: AAPL.XNAS
OffsetDateTime startTime = new OffsetDateTime(); // OffsetDateTime | The start time of the window. UTC time formatted according to ISO 8601 (i.e: 2022-02-01T13:45:17)
OffsetDateTime endTime = new OffsetDateTime(); // OffsetDateTime | The end time of the window. UTC time formatted according to ISO 8601 (i.e: 2022-02-01T13:45:17)
Integer page = 1; // Integer | The number of the page to request.
Integer pageSize = 1000; // Integer | The number of elements in each page. Max value: 50000.
try {
    PricesResponse result = apiInstance.intraday(fullTicker, startTime, endTime, page, pageSize);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PricesApi#intraday");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
fullTicker String The fully qualified ticker of the stock. Example: AAPL.XNAS
startTime OffsetDateTime The start time of the window. UTC time formatted according to ISO 8601 (i.e: 2022-02-01T13:45:17) [optional]
endTime OffsetDateTime The end time of the window. UTC time formatted according to ISO 8601 (i.e: 2022-02-01T13:45:17) [optional]
page Integer The number of the page to request. [optional] [default to 1]
pageSize Integer The number of elements in each page. Max value: 50000. [optional] [default to 1000]

Return type

PricesResponse

Authorization

[Query String](../README.md#Query String)

HTTP request headers

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