Package net.jacobpeterson.alpaca.openapi.marketdata.api

Class StockApi

java.lang.Object
net.jacobpeterson.alpaca.openapi.marketdata.api.StockApi
public class StockApi extends Object

  • Constructor Details

    • StockApi

      public StockApi()

    • StockApi

      public StockApi(ApiClient apiClient)

  • Method Details

    • stockAuctionSingleCall

      protected okhttp3.Call stockAuctionSingleCall(String symbol, OffsetDateTime start, OffsetDateTime end, Long limit, String asof, StockFeed feed, String currency, String pageToken, Sort sort, ApiCallback _callback) throws ApiException
      Build call for stockAuctionSingle
      Parameters:
      symbol - The symbol to query for. (required)
      start - The inclusive start of the interval. Format: RFC-3339 or YYYY-MM-DD. If missing, the default value is the beginning of the current day. (optional)
      end - The inclusive end of the interval. Format: RFC-3339 or YYYY-MM-DD. If missing, the default value is the current time. (optional)
      limit - The maximum number of data points to return in the response. The API may return less, even if there are more available data points in the requested interval. Always check the next_page_token for more pages. The limit applies to the total number of data points, not per symbol! (optional, default to 1000)
      asof - The asof date of the queried stock symbol(s) in YYYY-MM-DD format. Default is the current day. This date is used to identify the underlying entity of the provided symbol(s) so that name changes for this entity can be found. Data for past symbol(s) is returned if the query date range spans the name change. The special value of \"-\" means symbol mapping is skipped. Data is returned based on the symbol alone without looking up previous names. The same happens if the queried symbol is not found on the given asof date. Example: FB was renamed to META in 2022-06-09. Querying META with an asof date after 2022-06-09 will also yield FB data. The data for the FB ticker will be labeled as META because they are considered the same underlying entity as of 2022-06-09. Querying FB with an asof date after 2022-06-09 will only return data with the FB ticker, not with META. But with an asof date before 2022-06-09, META will also be returned (as FB). (optional)
      feed - The source feed of the data. `sip` contains all US exchanges, `iex` contains only the Investors Exchange. `otc` contains over the counter exchanges. Default: `sip` for the non-latest endpoints or if the user has the unlimited subscription, `iex` otherwise. (optional, default to sip)
      currency - The currency of all prices in ISO 4217 format. Default is USD. (optional)
      pageToken - Pagination token to continue from. The value to pass here is returned in specific requests when more data is available than the request limit allows. (optional)
      sort - Sort data in ascending or descending order. (optional, default to asc)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • stockAuctionSingle

      public StockAuctionsRespSingle stockAuctionSingle(String symbol, OffsetDateTime start, OffsetDateTime end, Long limit, String asof, StockFeed feed, String currency, String pageToken, Sort sort) throws ApiException
      Historical auctions (single) The historical auctions endpoint provides auction prices for a list of stock symbols between the specified dates.
      Parameters:
      symbol - The symbol to query for. (required)
      start - The inclusive start of the interval. Format: RFC-3339 or YYYY-MM-DD. If missing, the default value is the beginning of the current day. (optional)
      end - The inclusive end of the interval. Format: RFC-3339 or YYYY-MM-DD. If missing, the default value is the current time. (optional)
      limit - The maximum number of data points to return in the response. The API may return less, even if there are more available data points in the requested interval. Always check the next_page_token for more pages. The limit applies to the total number of data points, not per symbol! (optional, default to 1000)
      asof - The asof date of the queried stock symbol(s) in YYYY-MM-DD format. Default is the current day. This date is used to identify the underlying entity of the provided symbol(s) so that name changes for this entity can be found. Data for past symbol(s) is returned if the query date range spans the name change. The special value of \"-\" means symbol mapping is skipped. Data is returned based on the symbol alone without looking up previous names. The same happens if the queried symbol is not found on the given asof date. Example: FB was renamed to META in 2022-06-09. Querying META with an asof date after 2022-06-09 will also yield FB data. The data for the FB ticker will be labeled as META because they are considered the same underlying entity as of 2022-06-09. Querying FB with an asof date after 2022-06-09 will only return data with the FB ticker, not with META. But with an asof date before 2022-06-09, META will also be returned (as FB). (optional)
      feed - The source feed of the data. `sip` contains all US exchanges, `iex` contains only the Investors Exchange. `otc` contains over the counter exchanges. Default: `sip` for the non-latest endpoints or if the user has the unlimited subscription, `iex` otherwise. (optional, default to sip)
      currency - The currency of all prices in ISO 4217 format. Default is USD. (optional)
      pageToken - Pagination token to continue from. The value to pass here is returned in specific requests when more data is available than the request limit allows. (optional)
      sort - Sort data in ascending or descending order. (optional, default to asc)
      Returns:
      StockAuctionsRespSingle
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • stockAuctionSingleWithHttpInfo

      protected ApiResponse<StockAuctionsRespSingle> stockAuctionSingleWithHttpInfo(String symbol, OffsetDateTime start, OffsetDateTime end, Long limit, String asof, StockFeed feed, String currency, String pageToken, Sort sort) throws ApiException
      Historical auctions (single) The historical auctions endpoint provides auction prices for a list of stock symbols between the specified dates.
      Parameters:
      symbol - The symbol to query for. (required)
      start - The inclusive start of the interval. Format: RFC-3339 or YYYY-MM-DD. If missing, the default value is the beginning of the current day. (optional)
      end - The inclusive end of the interval. Format: RFC-3339 or YYYY-MM-DD. If missing, the default value is the current time. (optional)
      limit - The maximum number of data points to return in the response. The API may return less, even if there are more available data points in the requested interval. Always check the next_page_token for more pages. The limit applies to the total number of data points, not per symbol! (optional, default to 1000)
      asof - The asof date of the queried stock symbol(s) in YYYY-MM-DD format. Default is the current day. This date is used to identify the underlying entity of the provided symbol(s) so that name changes for this entity can be found. Data for past symbol(s) is returned if the query date range spans the name change. The special value of \"-\" means symbol mapping is skipped. Data is returned based on the symbol alone without looking up previous names. The same happens if the queried symbol is not found on the given asof date. Example: FB was renamed to META in 2022-06-09. Querying META with an asof date after 2022-06-09 will also yield FB data. The data for the FB ticker will be labeled as META because they are considered the same underlying entity as of 2022-06-09. Querying FB with an asof date after 2022-06-09 will only return data with the FB ticker, not with META. But with an asof date before 2022-06-09, META will also be returned (as FB). (optional)
      feed - The source feed of the data. `sip` contains all US exchanges, `iex` contains only the Investors Exchange. `otc` contains over the counter exchanges. Default: `sip` for the non-latest endpoints or if the user has the unlimited subscription, `iex` otherwise. (optional, default to sip)
      currency - The currency of all prices in ISO 4217 format. Default is USD. (optional)
      pageToken - Pagination token to continue from. The value to pass here is returned in specific requests when more data is available than the request limit allows. (optional)
      sort - Sort data in ascending or descending order. (optional, default to asc)
      Returns:
      ApiResponse<StockAuctionsRespSingle>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • stockAuctionSingleAsync

      protected okhttp3.Call stockAuctionSingleAsync(String symbol, OffsetDateTime start, OffsetDateTime end, Long limit, String asof, StockFeed feed, String currency, String pageToken, Sort sort, ApiCallback<StockAuctionsRespSingle> _callback) throws ApiException
      Historical auctions (single) (asynchronously) The historical auctions endpoint provides auction prices for a list of stock symbols between the specified dates.
      Parameters:
      symbol - The symbol to query for. (required)
      start - The inclusive start of the interval. Format: RFC-3339 or YYYY-MM-DD. If missing, the default value is the beginning of the current day. (optional)
      end - The inclusive end of the interval. Format: RFC-3339 or YYYY-MM-DD. If missing, the default value is the current time. (optional)
      limit - The maximum number of data points to return in the response. The API may return less, even if there are more available data points in the requested interval. Always check the next_page_token for more pages. The limit applies to the total number of data points, not per symbol! (optional, default to 1000)
      asof - The asof date of the queried stock symbol(s) in YYYY-MM-DD format. Default is the current day. This date is used to identify the underlying entity of the provided symbol(s) so that name changes for this entity can be found. Data for past symbol(s) is returned if the query date range spans the name change. The special value of \"-\" means symbol mapping is skipped. Data is returned based on the symbol alone without looking up previous names. The same happens if the queried symbol is not found on the given asof date. Example: FB was renamed to META in 2022-06-09. Querying META with an asof date after 2022-06-09 will also yield FB data. The data for the FB ticker will be labeled as META because they are considered the same underlying entity as of 2022-06-09. Querying FB with an asof date after 2022-06-09 will only return data with the FB ticker, not with META. But with an asof date before 2022-06-09, META will also be returned (as FB). (optional)
      feed - The source feed of the data. `sip` contains all US exchanges, `iex` contains only the Investors Exchange. `otc` contains over the counter exchanges. Default: `sip` for the non-latest endpoints or if the user has the unlimited subscription, `iex` otherwise. (optional, default to sip)
      currency - The currency of all prices in ISO 4217 format. Default is USD. (optional)
      pageToken - Pagination token to continue from. The value to pass here is returned in specific requests when more data is available than the request limit allows. (optional)
      sort - Sort data in ascending or descending order. (optional, default to asc)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object

    • stockAuctionsCall

      protected okhttp3.Call stockAuctionsCall(String symbols, OffsetDateTime start, OffsetDateTime end, Long limit, String asof, StockFeed feed, String currency, String pageToken, Sort sort, ApiCallback _callback) throws ApiException
      Build call for stockAuctions
      Parameters:
      symbols - Comma separated list of symbols. (required)
      start - The inclusive start of the interval. Format: RFC-3339 or YYYY-MM-DD. If missing, the default value is the beginning of the current day. (optional)
      end - The inclusive end of the interval. Format: RFC-3339 or YYYY-MM-DD. If missing, the default value is the current time. (optional)
      limit - The maximum number of data points to return in the response. The API may return less, even if there are more available data points in the requested interval. Always check the next_page_token for more pages. The limit applies to the total number of data points, not per symbol! (optional, default to 1000)
      asof - The asof date of the queried stock symbol(s) in YYYY-MM-DD format. Default is the current day. This date is used to identify the underlying entity of the provided symbol(s) so that name changes for this entity can be found. Data for past symbol(s) is returned if the query date range spans the name change. The special value of \"-\" means symbol mapping is skipped. Data is returned based on the symbol alone without looking up previous names. The same happens if the queried symbol is not found on the given asof date. Example: FB was renamed to META in 2022-06-09. Querying META with an asof date after 2022-06-09 will also yield FB data. The data for the FB ticker will be labeled as META because they are considered the same underlying entity as of 2022-06-09. Querying FB with an asof date after 2022-06-09 will only return data with the FB ticker, not with META. But with an asof date before 2022-06-09, META will also be returned (as FB). (optional)
      feed - The source feed of the data. `sip` contains all US exchanges, `iex` contains only the Investors Exchange. `otc` contains over the counter exchanges. Default: `sip` for the non-latest endpoints or if the user has the unlimited subscription, `iex` otherwise. (optional, default to sip)
      currency - The currency of all prices in ISO 4217 format. Default is USD. (optional)
      pageToken - Pagination token to continue from. The value to pass here is returned in specific requests when more data is available than the request limit allows. (optional)
      sort - Sort data in ascending or descending order. (optional, default to asc)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • stockAuctions

      public StockAuctionsResp stockAuctions(String symbols, OffsetDateTime start, OffsetDateTime end, Long limit, String asof, StockFeed feed, String currency, String pageToken, Sort sort) throws ApiException
      Historical auctions The historical auctions endpoint provides auction prices for the stock symbol between the specified dates.
      Parameters:
      symbols - Comma separated list of symbols. (required)
      start - The inclusive start of the interval. Format: RFC-3339 or YYYY-MM-DD. If missing, the default value is the beginning of the current day. (optional)
      end - The inclusive end of the interval. Format: RFC-3339 or YYYY-MM-DD. If missing, the default value is the current time. (optional)
      limit - The maximum number of data points to return in the response. The API may return less, even if there are more available data points in the requested interval. Always check the next_page_token for more pages. The limit applies to the total number of data points, not per symbol! (optional, default to 1000)
      asof - The asof date of the queried stock symbol(s) in YYYY-MM-DD format. Default is the current day. This date is used to identify the underlying entity of the provided symbol(s) so that name changes for this entity can be found. Data for past symbol(s) is returned if the query date range spans the name change. The special value of \"-\" means symbol mapping is skipped. Data is returned based on the symbol alone without looking up previous names. The same happens if the queried symbol is not found on the given asof date. Example: FB was renamed to META in 2022-06-09. Querying META with an asof date after 2022-06-09 will also yield FB data. The data for the FB ticker will be labeled as META because they are considered the same underlying entity as of 2022-06-09. Querying FB with an asof date after 2022-06-09 will only return data with the FB ticker, not with META. But with an asof date before 2022-06-09, META will also be returned (as FB). (optional)
      feed - The source feed of the data. `sip` contains all US exchanges, `iex` contains only the Investors Exchange. `otc` contains over the counter exchanges. Default: `sip` for the non-latest endpoints or if the user has the unlimited subscription, `iex` otherwise. (optional, default to sip)
      currency - The currency of all prices in ISO 4217 format. Default is USD. (optional)
      pageToken - Pagination token to continue from. The value to pass here is returned in specific requests when more data is available than the request limit allows. (optional)
      sort - Sort data in ascending or descending order. (optional, default to asc)
      Returns:
      StockAuctionsResp
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • stockAuctionsWithHttpInfo

      protected ApiResponse<StockAuctionsResp> stockAuctionsWithHttpInfo(String symbols, OffsetDateTime start, OffsetDateTime end, Long limit, String asof, StockFeed feed, String currency, String pageToken, Sort sort) throws ApiException
      Historical auctions The historical auctions endpoint provides auction prices for the stock symbol between the specified dates.
      Parameters:
      symbols - Comma separated list of symbols. (required)
      start - The inclusive start of the interval. Format: RFC-3339 or YYYY-MM-DD. If missing, the default value is the beginning of the current day. (optional)
      end - The inclusive end of the interval. Format: RFC-3339 or YYYY-MM-DD. If missing, the default value is the current time. (optional)
      limit - The maximum number of data points to return in the response. The API may return less, even if there are more available data points in the requested interval. Always check the next_page_token for more pages. The limit applies to the total number of data points, not per symbol! (optional, default to 1000)
      asof - The asof date of the queried stock symbol(s) in YYYY-MM-DD format. Default is the current day. This date is used to identify the underlying entity of the provided symbol(s) so that name changes for this entity can be found. Data for past symbol(s) is returned if the query date range spans the name change. The special value of \"-\" means symbol mapping is skipped. Data is returned based on the symbol alone without looking up previous names. The same happens if the queried symbol is not found on the given asof date. Example: FB was renamed to META in 2022-06-09. Querying META with an asof date after 2022-06-09 will also yield FB data. The data for the FB ticker will be labeled as META because they are considered the same underlying entity as of 2022-06-09. Querying FB with an asof date after 2022-06-09 will only return data with the FB ticker, not with META. But with an asof date before 2022-06-09, META will also be returned (as FB). (optional)
      feed - The source feed of the data. `sip` contains all US exchanges, `iex` contains only the Investors Exchange. `otc` contains over the counter exchanges. Default: `sip` for the non-latest endpoints or if the user has the unlimited subscription, `iex` otherwise. (optional, default to sip)
      currency - The currency of all prices in ISO 4217 format. Default is USD. (optional)
      pageToken - Pagination token to continue from. The value to pass here is returned in specific requests when more data is available than the request limit allows. (optional)
      sort - Sort data in ascending or descending order. (optional, default to asc)
      Returns:
      ApiResponse<StockAuctionsResp>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • stockAuctionsAsync

      protected okhttp3.Call stockAuctionsAsync(String symbols, OffsetDateTime start, OffsetDateTime end, Long limit, String asof, StockFeed feed, String currency, String pageToken, Sort sort, ApiCallback<StockAuctionsResp> _callback) throws ApiException
      Historical auctions (asynchronously) The historical auctions endpoint provides auction prices for the stock symbol between the specified dates.
      Parameters:
      symbols - Comma separated list of symbols. (required)
      start - The inclusive start of the interval. Format: RFC-3339 or YYYY-MM-DD. If missing, the default value is the beginning of the current day. (optional)
      end - The inclusive end of the interval. Format: RFC-3339 or YYYY-MM-DD. If missing, the default value is the current time. (optional)
      limit - The maximum number of data points to return in the response. The API may return less, even if there are more available data points in the requested interval. Always check the next_page_token for more pages. The limit applies to the total number of data points, not per symbol! (optional, default to 1000)
      asof - The asof date of the queried stock symbol(s) in YYYY-MM-DD format. Default is the current day. This date is used to identify the underlying entity of the provided symbol(s) so that name changes for this entity can be found. Data for past symbol(s) is returned if the query date range spans the name change. The special value of \"-\" means symbol mapping is skipped. Data is returned based on the symbol alone without looking up previous names. The same happens if the queried symbol is not found on the given asof date. Example: FB was renamed to META in 2022-06-09. Querying META with an asof date after 2022-06-09 will also yield FB data. The data for the FB ticker will be labeled as META because they are considered the same underlying entity as of 2022-06-09. Querying FB with an asof date after 2022-06-09 will only return data with the FB ticker, not with META. But with an asof date before 2022-06-09, META will also be returned (as FB). (optional)
      feed - The source feed of the data. `sip` contains all US exchanges, `iex` contains only the Investors Exchange. `otc` contains over the counter exchanges. Default: `sip` for the non-latest endpoints or if the user has the unlimited subscription, `iex` otherwise. (optional, default to sip)
      currency - The currency of all prices in ISO 4217 format. Default is USD. (optional)
      pageToken - Pagination token to continue from. The value to pass here is returned in specific requests when more data is available than the request limit allows. (optional)
      sort - Sort data in ascending or descending order. (optional, default to asc)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object

    • stockBarSingleCall

      protected okhttp3.Call stockBarSingleCall(String symbol, String timeframe, OffsetDateTime start, OffsetDateTime end, Long limit, StockAdjustment adjustment, String asof, StockFeed feed, String currency, String pageToken, Sort sort, ApiCallback _callback) throws ApiException
      Build call for stockBarSingle
      Parameters:
      symbol - The symbol to query for. (required)
      timeframe - The timeframe of the bar aggregation. 5Min for example creates 5 minute aggregates. You can use the following values: - [1-59]Min / T - [1-23]Hour / H - 1Day / D - 1Week / W - [1,2,3,4,6,12]Month / M (required)
      start - The inclusive start of the interval. Format: RFC-3339 or YYYY-MM-DD. If missing, the default value is the beginning of the current day. (optional)
      end - The inclusive end of the interval. Format: RFC-3339 or YYYY-MM-DD. If missing, the default value is the current time. (optional)
      limit - The maximum number of data points to return in the response. The API may return less, even if there are more available data points in the requested interval. Always check the next_page_token for more pages. The limit applies to the total number of data points, not per symbol! (optional, default to 1000)
      adjustment - Specifies the corporate action adjustment for the stocks. (optional, default to raw)
      asof - The asof date of the queried stock symbol(s) in YYYY-MM-DD format. Default is the current day. This date is used to identify the underlying entity of the provided symbol(s) so that name changes for this entity can be found. Data for past symbol(s) is returned if the query date range spans the name change. The special value of \"-\" means symbol mapping is skipped. Data is returned based on the symbol alone without looking up previous names. The same happens if the queried symbol is not found on the given asof date. Example: FB was renamed to META in 2022-06-09. Querying META with an asof date after 2022-06-09 will also yield FB data. The data for the FB ticker will be labeled as META because they are considered the same underlying entity as of 2022-06-09. Querying FB with an asof date after 2022-06-09 will only return data with the FB ticker, not with META. But with an asof date before 2022-06-09, META will also be returned (as FB). (optional)
      feed - The source feed of the data. `sip` contains all US exchanges, `iex` contains only the Investors Exchange. `otc` contains over the counter exchanges. Default: `sip` for the non-latest endpoints or if the user has the unlimited subscription, `iex` otherwise. (optional, default to sip)
      currency - The currency of all prices in ISO 4217 format. Default is USD. (optional)
      pageToken - Pagination token to continue from. The value to pass here is returned in specific requests when more data is available than the request limit allows. (optional)
      sort - Sort data in ascending or descending order. (optional, default to asc)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • stockBarSingle

      public StockBarsRespSingle stockBarSingle(String symbol, String timeframe, OffsetDateTime start, OffsetDateTime end, Long limit, StockAdjustment adjustment, String asof, StockFeed feed, String currency, String pageToken, Sort sort) throws ApiException
      Historical bars (single symbol) The historical stock bars API provides aggregates for the stock symbol between the specified dates.
      Parameters:
      symbol - The symbol to query for. (required)
      timeframe - The timeframe of the bar aggregation. 5Min for example creates 5 minute aggregates. You can use the following values: - [1-59]Min / T - [1-23]Hour / H - 1Day / D - 1Week / W - [1,2,3,4,6,12]Month / M (required)
      start - The inclusive start of the interval. Format: RFC-3339 or YYYY-MM-DD. If missing, the default value is the beginning of the current day. (optional)
      end - The inclusive end of the interval. Format: RFC-3339 or YYYY-MM-DD. If missing, the default value is the current time. (optional)
      limit - The maximum number of data points to return in the response. The API may return less, even if there are more available data points in the requested interval. Always check the next_page_token for more pages. The limit applies to the total number of data points, not per symbol! (optional, default to 1000)
      adjustment - Specifies the corporate action adjustment for the stocks. (optional, default to raw)
      asof - The asof date of the queried stock symbol(s) in YYYY-MM-DD format. Default is the current day. This date is used to identify the underlying entity of the provided symbol(s) so that name changes for this entity can be found. Data for past symbol(s) is returned if the query date range spans the name change. The special value of \"-\" means symbol mapping is skipped. Data is returned based on the symbol alone without looking up previous names. The same happens if the queried symbol is not found on the given asof date. Example: FB was renamed to META in 2022-06-09. Querying META with an asof date after 2022-06-09 will also yield FB data. The data for the FB ticker will be labeled as META because they are considered the same underlying entity as of 2022-06-09. Querying FB with an asof date after 2022-06-09 will only return data with the FB ticker, not with META. But with an asof date before 2022-06-09, META will also be returned (as FB). (optional)
      feed - The source feed of the data. `sip` contains all US exchanges, `iex` contains only the Investors Exchange. `otc` contains over the counter exchanges. Default: `sip` for the non-latest endpoints or if the user has the unlimited subscription, `iex` otherwise. (optional, default to sip)
      currency - The currency of all prices in ISO 4217 format. Default is USD. (optional)
      pageToken - Pagination token to continue from. The value to pass here is returned in specific requests when more data is available than the request limit allows. (optional)
      sort - Sort data in ascending or descending order. (optional, default to asc)
      Returns:
      StockBarsRespSingle
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • stockBarSingleWithHttpInfo

      protected ApiResponse<StockBarsRespSingle> stockBarSingleWithHttpInfo(String symbol, String timeframe, OffsetDateTime start, OffsetDateTime end, Long limit, StockAdjustment adjustment, String asof, StockFeed feed, String currency, String pageToken, Sort sort) throws ApiException
      Historical bars (single symbol) The historical stock bars API provides aggregates for the stock symbol between the specified dates.
      Parameters:
      symbol - The symbol to query for. (required)
      timeframe - The timeframe of the bar aggregation. 5Min for example creates 5 minute aggregates. You can use the following values: - [1-59]Min / T - [1-23]Hour / H - 1Day / D - 1Week / W - [1,2,3,4,6,12]Month / M (required)
      start - The inclusive start of the interval. Format: RFC-3339 or YYYY-MM-DD. If missing, the default value is the beginning of the current day. (optional)
      end - The inclusive end of the interval. Format: RFC-3339 or YYYY-MM-DD. If missing, the default value is the current time. (optional)
      limit - The maximum number of data points to return in the response. The API may return less, even if there are more available data points in the requested interval. Always check the next_page_token for more pages. The limit applies to the total number of data points, not per symbol! (optional, default to 1000)
      adjustment - Specifies the corporate action adjustment for the stocks. (optional, default to raw)
      asof - The asof date of the queried stock symbol(s) in YYYY-MM-DD format. Default is the current day. This date is used to identify the underlying entity of the provided symbol(s) so that name changes for this entity can be found. Data for past symbol(s) is returned if the query date range spans the name change. The special value of \"-\" means symbol mapping is skipped. Data is returned based on the symbol alone without looking up previous names. The same happens if the queried symbol is not found on the given asof date. Example: FB was renamed to META in 2022-06-09. Querying META with an asof date after 2022-06-09 will also yield FB data. The data for the FB ticker will be labeled as META because they are considered the same underlying entity as of 2022-06-09. Querying FB with an asof date after 2022-06-09 will only return data with the FB ticker, not with META. But with an asof date before 2022-06-09, META will also be returned (as FB). (optional)
      feed - The source feed of the data. `sip` contains all US exchanges, `iex` contains only the Investors Exchange. `otc` contains over the counter exchanges. Default: `sip` for the non-latest endpoints or if the user has the unlimited subscription, `iex` otherwise. (optional, default to sip)
      currency - The currency of all prices in ISO 4217 format. Default is USD. (optional)
      pageToken - Pagination token to continue from. The value to pass here is returned in specific requests when more data is available than the request limit allows. (optional)
      sort - Sort data in ascending or descending order. (optional, default to asc)
      Returns:
      ApiResponse<StockBarsRespSingle>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • stockBarSingleAsync

      protected okhttp3.Call stockBarSingleAsync(String symbol, String timeframe, OffsetDateTime start, OffsetDateTime end, Long limit, StockAdjustment adjustment, String asof, StockFeed feed, String currency, String pageToken, Sort sort, ApiCallback<StockBarsRespSingle> _callback) throws ApiException
      Historical bars (single symbol) (asynchronously) The historical stock bars API provides aggregates for the stock symbol between the specified dates.
      Parameters:
      symbol - The symbol to query for. (required)
      timeframe - The timeframe of the bar aggregation. 5Min for example creates 5 minute aggregates. You can use the following values: - [1-59]Min / T - [1-23]Hour / H - 1Day / D - 1Week / W - [1,2,3,4,6,12]Month / M (required)
      start - The inclusive start of the interval. Format: RFC-3339 or YYYY-MM-DD. If missing, the default value is the beginning of the current day. (optional)
      end - The inclusive end of the interval. Format: RFC-3339 or YYYY-MM-DD. If missing, the default value is the current time. (optional)
      limit - The maximum number of data points to return in the response. The API may return less, even if there are more available data points in the requested interval. Always check the next_page_token for more pages. The limit applies to the total number of data points, not per symbol! (optional, default to 1000)
      adjustment - Specifies the corporate action adjustment for the stocks. (optional, default to raw)
      asof - The asof date of the queried stock symbol(s) in YYYY-MM-DD format. Default is the current day. This date is used to identify the underlying entity of the provided symbol(s) so that name changes for this entity can be found. Data for past symbol(s) is returned if the query date range spans the name change. The special value of \"-\" means symbol mapping is skipped. Data is returned based on the symbol alone without looking up previous names. The same happens if the queried symbol is not found on the given asof date. Example: FB was renamed to META in 2022-06-09. Querying META with an asof date after 2022-06-09 will also yield FB data. The data for the FB ticker will be labeled as META because they are considered the same underlying entity as of 2022-06-09. Querying FB with an asof date after 2022-06-09 will only return data with the FB ticker, not with META. But with an asof date before 2022-06-09, META will also be returned (as FB). (optional)
      feed - The source feed of the data. `sip` contains all US exchanges, `iex` contains only the Investors Exchange. `otc` contains over the counter exchanges. Default: `sip` for the non-latest endpoints or if the user has the unlimited subscription, `iex` otherwise. (optional, default to sip)
      currency - The currency of all prices in ISO 4217 format. Default is USD. (optional)
      pageToken - Pagination token to continue from. The value to pass here is returned in specific requests when more data is available than the request limit allows. (optional)
      sort - Sort data in ascending or descending order. (optional, default to asc)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object

    • stockBarsCall

      protected okhttp3.Call stockBarsCall(String symbols, String timeframe, OffsetDateTime start, OffsetDateTime end, Long limit, StockAdjustment adjustment, String asof, StockFeed feed, String currency, String pageToken, Sort sort, ApiCallback _callback) throws ApiException
      Build call for stockBars
      Parameters:
      symbols - Comma separated list of symbols. (required)
      timeframe - The timeframe of the bar aggregation. 5Min for example creates 5 minute aggregates. You can use the following values: - [1-59]Min / T - [1-23]Hour / H - 1Day / D - 1Week / W - [1,2,3,4,6,12]Month / M (required)
      start - The inclusive start of the interval. Format: RFC-3339 or YYYY-MM-DD. If missing, the default value is the beginning of the current day. (optional)
      end - The inclusive end of the interval. Format: RFC-3339 or YYYY-MM-DD. If missing, the default value is the current time. (optional)
      limit - The maximum number of data points to return in the response. The API may return less, even if there are more available data points in the requested interval. Always check the next_page_token for more pages. The limit applies to the total number of data points, not per symbol! (optional, default to 1000)
      adjustment - Specifies the corporate action adjustment for the stocks. (optional, default to raw)
      asof - The asof date of the queried stock symbol(s) in YYYY-MM-DD format. Default is the current day. This date is used to identify the underlying entity of the provided symbol(s) so that name changes for this entity can be found. Data for past symbol(s) is returned if the query date range spans the name change. The special value of \"-\" means symbol mapping is skipped. Data is returned based on the symbol alone without looking up previous names. The same happens if the queried symbol is not found on the given asof date. Example: FB was renamed to META in 2022-06-09. Querying META with an asof date after 2022-06-09 will also yield FB data. The data for the FB ticker will be labeled as META because they are considered the same underlying entity as of 2022-06-09. Querying FB with an asof date after 2022-06-09 will only return data with the FB ticker, not with META. But with an asof date before 2022-06-09, META will also be returned (as FB). (optional)
      feed - The source feed of the data. `sip` contains all US exchanges, `iex` contains only the Investors Exchange. `otc` contains over the counter exchanges. Default: `sip` for the non-latest endpoints or if the user has the unlimited subscription, `iex` otherwise. (optional, default to sip)
      currency - The currency of all prices in ISO 4217 format. Default is USD. (optional)
      pageToken - Pagination token to continue from. The value to pass here is returned in specific requests when more data is available than the request limit allows. (optional)
      sort - Sort data in ascending or descending order. (optional, default to asc)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • stockBars

      public StockBarsResp stockBars(String symbols, String timeframe, OffsetDateTime start, OffsetDateTime end, Long limit, StockAdjustment adjustment, String asof, StockFeed feed, String currency, String pageToken, Sort sort) throws ApiException
      Historical bars The historical stock bars API provides aggregates for a list of stock symbols between the specified dates. The returned results are sorted by symbol first then by bar timestamp. This means that you are likely to see only one symbol in your first response if there are enough bars for that symbol to hit the limit you requested on that request. In these situations if you keep requesting again with the `next_page_token` you will eventually reach the next symbols if any bars were found for them.
      Parameters:
      symbols - Comma separated list of symbols. (required)
      timeframe - The timeframe of the bar aggregation. 5Min for example creates 5 minute aggregates. You can use the following values: - [1-59]Min / T - [1-23]Hour / H - 1Day / D - 1Week / W - [1,2,3,4,6,12]Month / M (required)
      start - The inclusive start of the interval. Format: RFC-3339 or YYYY-MM-DD. If missing, the default value is the beginning of the current day. (optional)
      end - The inclusive end of the interval. Format: RFC-3339 or YYYY-MM-DD. If missing, the default value is the current time. (optional)
      limit - The maximum number of data points to return in the response. The API may return less, even if there are more available data points in the requested interval. Always check the next_page_token for more pages. The limit applies to the total number of data points, not per symbol! (optional, default to 1000)
      adjustment - Specifies the corporate action adjustment for the stocks. (optional, default to raw)
      asof - The asof date of the queried stock symbol(s) in YYYY-MM-DD format. Default is the current day. This date is used to identify the underlying entity of the provided symbol(s) so that name changes for this entity can be found. Data for past symbol(s) is returned if the query date range spans the name change. The special value of \"-\" means symbol mapping is skipped. Data is returned based on the symbol alone without looking up previous names. The same happens if the queried symbol is not found on the given asof date. Example: FB was renamed to META in 2022-06-09. Querying META with an asof date after 2022-06-09 will also yield FB data. The data for the FB ticker will be labeled as META because they are considered the same underlying entity as of 2022-06-09. Querying FB with an asof date after 2022-06-09 will only return data with the FB ticker, not with META. But with an asof date before 2022-06-09, META will also be returned (as FB). (optional)
      feed - The source feed of the data. `sip` contains all US exchanges, `iex` contains only the Investors Exchange. `otc` contains over the counter exchanges. Default: `sip` for the non-latest endpoints or if the user has the unlimited subscription, `iex` otherwise. (optional, default to sip)
      currency - The currency of all prices in ISO 4217 format. Default is USD. (optional)
      pageToken - Pagination token to continue from. The value to pass here is returned in specific requests when more data is available than the request limit allows. (optional)
      sort - Sort data in ascending or descending order. (optional, default to asc)
      Returns:
      StockBarsResp
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • stockBarsWithHttpInfo

      protected ApiResponse<StockBarsResp> stockBarsWithHttpInfo(String symbols, String timeframe, OffsetDateTime start, OffsetDateTime end, Long limit, StockAdjustment adjustment, String asof, StockFeed feed, String currency, String pageToken, Sort sort) throws ApiException
      Historical bars The historical stock bars API provides aggregates for a list of stock symbols between the specified dates. The returned results are sorted by symbol first then by bar timestamp. This means that you are likely to see only one symbol in your first response if there are enough bars for that symbol to hit the limit you requested on that request. In these situations if you keep requesting again with the `next_page_token` you will eventually reach the next symbols if any bars were found for them.
      Parameters:
      symbols - Comma separated list of symbols. (required)
      timeframe - The timeframe of the bar aggregation. 5Min for example creates 5 minute aggregates. You can use the following values: - [1-59]Min / T - [1-23]Hour / H - 1Day / D - 1Week / W - [1,2,3,4,6,12]Month / M (required)
      start - The inclusive start of the interval. Format: RFC-3339 or YYYY-MM-DD. If missing, the default value is the beginning of the current day. (optional)
      end - The inclusive end of the interval. Format: RFC-3339 or YYYY-MM-DD. If missing, the default value is the current time. (optional)
      limit - The maximum number of data points to return in the response. The API may return less, even if there are more available data points in the requested interval. Always check the next_page_token for more pages. The limit applies to the total number of data points, not per symbol! (optional, default to 1000)
      adjustment - Specifies the corporate action adjustment for the stocks. (optional, default to raw)
      asof - The asof date of the queried stock symbol(s) in YYYY-MM-DD format. Default is the current day. This date is used to identify the underlying entity of the provided symbol(s) so that name changes for this entity can be found. Data for past symbol(s) is returned if the query date range spans the name change. The special value of \"-\" means symbol mapping is skipped. Data is returned based on the symbol alone without looking up previous names. The same happens if the queried symbol is not found on the given asof date. Example: FB was renamed to META in 2022-06-09. Querying META with an asof date after 2022-06-09 will also yield FB data. The data for the FB ticker will be labeled as META because they are considered the same underlying entity as of 2022-06-09. Querying FB with an asof date after 2022-06-09 will only return data with the FB ticker, not with META. But with an asof date before 2022-06-09, META will also be returned (as FB). (optional)
      feed - The source feed of the data. `sip` contains all US exchanges, `iex` contains only the Investors Exchange. `otc` contains over the counter exchanges. Default: `sip` for the non-latest endpoints or if the user has the unlimited subscription, `iex` otherwise. (optional, default to sip)
      currency - The currency of all prices in ISO 4217 format. Default is USD. (optional)
      pageToken - Pagination token to continue from. The value to pass here is returned in specific requests when more data is available than the request limit allows. (optional)
      sort - Sort data in ascending or descending order. (optional, default to asc)
      Returns:
      ApiResponse<StockBarsResp>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • stockBarsAsync

      protected okhttp3.Call stockBarsAsync(String symbols, String timeframe, OffsetDateTime start, OffsetDateTime end, Long limit, StockAdjustment adjustment, String asof, StockFeed feed, String currency, String pageToken, Sort sort, ApiCallback<StockBarsResp> _callback) throws ApiException
      Historical bars (asynchronously) The historical stock bars API provides aggregates for a list of stock symbols between the specified dates. The returned results are sorted by symbol first then by bar timestamp. This means that you are likely to see only one symbol in your first response if there are enough bars for that symbol to hit the limit you requested on that request. In these situations if you keep requesting again with the `next_page_token` you will eventually reach the next symbols if any bars were found for them.
      Parameters:
      symbols - Comma separated list of symbols. (required)
      timeframe - The timeframe of the bar aggregation. 5Min for example creates 5 minute aggregates. You can use the following values: - [1-59]Min / T - [1-23]Hour / H - 1Day / D - 1Week / W - [1,2,3,4,6,12]Month / M (required)
      start - The inclusive start of the interval. Format: RFC-3339 or YYYY-MM-DD. If missing, the default value is the beginning of the current day. (optional)
      end - The inclusive end of the interval. Format: RFC-3339 or YYYY-MM-DD. If missing, the default value is the current time. (optional)
      limit - The maximum number of data points to return in the response. The API may return less, even if there are more available data points in the requested interval. Always check the next_page_token for more pages. The limit applies to the total number of data points, not per symbol! (optional, default to 1000)
      adjustment - Specifies the corporate action adjustment for the stocks. (optional, default to raw)
      asof - The asof date of the queried stock symbol(s) in YYYY-MM-DD format. Default is the current day. This date is used to identify the underlying entity of the provided symbol(s) so that name changes for this entity can be found. Data for past symbol(s) is returned if the query date range spans the name change. The special value of \"-\" means symbol mapping is skipped. Data is returned based on the symbol alone without looking up previous names. The same happens if the queried symbol is not found on the given asof date. Example: FB was renamed to META in 2022-06-09. Querying META with an asof date after 2022-06-09 will also yield FB data. The data for the FB ticker will be labeled as META because they are considered the same underlying entity as of 2022-06-09. Querying FB with an asof date after 2022-06-09 will only return data with the FB ticker, not with META. But with an asof date before 2022-06-09, META will also be returned (as FB). (optional)
      feed - The source feed of the data. `sip` contains all US exchanges, `iex` contains only the Investors Exchange. `otc` contains over the counter exchanges. Default: `sip` for the non-latest endpoints or if the user has the unlimited subscription, `iex` otherwise. (optional, default to sip)
      currency - The currency of all prices in ISO 4217 format. Default is USD. (optional)
      pageToken - Pagination token to continue from. The value to pass here is returned in specific requests when more data is available than the request limit allows. (optional)
      sort - Sort data in ascending or descending order. (optional, default to asc)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object

    • stockLatestBarSingleCall

      protected okhttp3.Call stockLatestBarSingleCall(String symbol, StockFeed feed, String currency, ApiCallback _callback) throws ApiException
      Build call for stockLatestBarSingle
      Parameters:
      symbol - The symbol to query for. (required)
      feed - The source feed of the data. `sip` contains all US exchanges, `iex` contains only the Investors Exchange. `otc` contains over the counter exchanges. Default: `sip` for the non-latest endpoints or if the user has the unlimited subscription, `iex` otherwise. (optional, default to sip)
      currency - The currency of all prices in ISO 4217 format. Default is USD. (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • stockLatestBarSingle

      public StockLatestBarsRespSingle stockLatestBarSingle(String symbol, StockFeed feed, String currency) throws ApiException
      Latest bar (single symbol) The latest stock bars endpoint returns the latest minute-aggregated historical bar for the requested security.
      Parameters:
      symbol - The symbol to query for. (required)
      feed - The source feed of the data. `sip` contains all US exchanges, `iex` contains only the Investors Exchange. `otc` contains over the counter exchanges. Default: `sip` for the non-latest endpoints or if the user has the unlimited subscription, `iex` otherwise. (optional, default to sip)
      currency - The currency of all prices in ISO 4217 format. Default is USD. (optional)
      Returns:
      StockLatestBarsRespSingle
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • stockLatestBarSingleWithHttpInfo

      protected ApiResponse<StockLatestBarsRespSingle> stockLatestBarSingleWithHttpInfo(String symbol, StockFeed feed, String currency) throws ApiException
      Latest bar (single symbol) The latest stock bars endpoint returns the latest minute-aggregated historical bar for the requested security.
      Parameters:
      symbol - The symbol to query for. (required)
      feed - The source feed of the data. `sip` contains all US exchanges, `iex` contains only the Investors Exchange. `otc` contains over the counter exchanges. Default: `sip` for the non-latest endpoints or if the user has the unlimited subscription, `iex` otherwise. (optional, default to sip)
      currency - The currency of all prices in ISO 4217 format. Default is USD. (optional)
      Returns:
      ApiResponse<StockLatestBarsRespSingle>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • stockLatestBarSingleAsync

      protected okhttp3.Call stockLatestBarSingleAsync(String symbol, StockFeed feed, String currency, ApiCallback<StockLatestBarsRespSingle> _callback) throws ApiException
      Latest bar (single symbol) (asynchronously) The latest stock bars endpoint returns the latest minute-aggregated historical bar for the requested security.
      Parameters:
      symbol - The symbol to query for. (required)
      feed - The source feed of the data. `sip` contains all US exchanges, `iex` contains only the Investors Exchange. `otc` contains over the counter exchanges. Default: `sip` for the non-latest endpoints or if the user has the unlimited subscription, `iex` otherwise. (optional, default to sip)
      currency - The currency of all prices in ISO 4217 format. Default is USD. (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object

    • stockLatestBarsCall

      protected okhttp3.Call stockLatestBarsCall(String symbols, StockFeed feed, String currency, ApiCallback _callback) throws ApiException
      Build call for stockLatestBars
      Parameters:
      symbols - Comma separated list of symbols. (required)
      feed - The source feed of the data. `sip` contains all US exchanges, `iex` contains only the Investors Exchange. `otc` contains over the counter exchanges. Default: `sip` for the non-latest endpoints or if the user has the unlimited subscription, `iex` otherwise. (optional, default to sip)
      currency - The currency of all prices in ISO 4217 format. Default is USD. (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • stockLatestBars

      public StockLatestBarsResp stockLatestBars(String symbols, StockFeed feed, String currency) throws ApiException
      Latest bars The latest multi bars endpoint returns the latest minute-aggregated historical bar data for the ticker symbols provided.
      Parameters:
      symbols - Comma separated list of symbols. (required)
      feed - The source feed of the data. `sip` contains all US exchanges, `iex` contains only the Investors Exchange. `otc` contains over the counter exchanges. Default: `sip` for the non-latest endpoints or if the user has the unlimited subscription, `iex` otherwise. (optional, default to sip)
      currency - The currency of all prices in ISO 4217 format. Default is USD. (optional)
      Returns:
      StockLatestBarsResp
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • stockLatestBarsWithHttpInfo

      protected ApiResponse<StockLatestBarsResp> stockLatestBarsWithHttpInfo(String symbols, StockFeed feed, String currency) throws ApiException
      Latest bars The latest multi bars endpoint returns the latest minute-aggregated historical bar data for the ticker symbols provided.
      Parameters:
      symbols - Comma separated list of symbols. (required)
      feed - The source feed of the data. `sip` contains all US exchanges, `iex` contains only the Investors Exchange. `otc` contains over the counter exchanges. Default: `sip` for the non-latest endpoints or if the user has the unlimited subscription, `iex` otherwise. (optional, default to sip)
      currency - The currency of all prices in ISO 4217 format. Default is USD. (optional)
      Returns:
      ApiResponse<StockLatestBarsResp>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • stockLatestBarsAsync

      protected okhttp3.Call stockLatestBarsAsync(String symbols, StockFeed feed, String currency, ApiCallback<StockLatestBarsResp> _callback) throws ApiException
      Latest bars (asynchronously) The latest multi bars endpoint returns the latest minute-aggregated historical bar data for the ticker symbols provided.
      Parameters:
      symbols - Comma separated list of symbols. (required)
      feed - The source feed of the data. `sip` contains all US exchanges, `iex` contains only the Investors Exchange. `otc` contains over the counter exchanges. Default: `sip` for the non-latest endpoints or if the user has the unlimited subscription, `iex` otherwise. (optional, default to sip)
      currency - The currency of all prices in ISO 4217 format. Default is USD. (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object

    • stockLatestQuoteSingleCall

      protected okhttp3.Call stockLatestQuoteSingleCall(String symbol, StockFeed feed, String currency, ApiCallback _callback) throws ApiException
      Build call for stockLatestQuoteSingle
      Parameters:
      symbol - The symbol to query for. (required)
      feed - The source feed of the data. `sip` contains all US exchanges, `iex` contains only the Investors Exchange. `otc` contains over the counter exchanges. Default: `sip` for the non-latest endpoints or if the user has the unlimited subscription, `iex` otherwise. (optional, default to sip)
      currency - The currency of all prices in ISO 4217 format. Default is USD. (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • stockLatestQuoteSingle

      public StockLatestQuotesRespSingle stockLatestQuoteSingle(String symbol, StockFeed feed, String currency) throws ApiException
      Latest quote (single symbol) The latest quotes endpoint provides the latest bid and ask prices for a given ticker symbol.
      Parameters:
      symbol - The symbol to query for. (required)
      feed - The source feed of the data. `sip` contains all US exchanges, `iex` contains only the Investors Exchange. `otc` contains over the counter exchanges. Default: `sip` for the non-latest endpoints or if the user has the unlimited subscription, `iex` otherwise. (optional, default to sip)
      currency - The currency of all prices in ISO 4217 format. Default is USD. (optional)
      Returns:
      StockLatestQuotesRespSingle
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • stockLatestQuoteSingleWithHttpInfo

      protected ApiResponse<StockLatestQuotesRespSingle> stockLatestQuoteSingleWithHttpInfo(String symbol, StockFeed feed, String currency) throws ApiException
      Latest quote (single symbol) The latest quotes endpoint provides the latest bid and ask prices for a given ticker symbol.
      Parameters:
      symbol - The symbol to query for. (required)
      feed - The source feed of the data. `sip` contains all US exchanges, `iex` contains only the Investors Exchange. `otc` contains over the counter exchanges. Default: `sip` for the non-latest endpoints or if the user has the unlimited subscription, `iex` otherwise. (optional, default to sip)
      currency - The currency of all prices in ISO 4217 format. Default is USD. (optional)
      Returns:
      ApiResponse<StockLatestQuotesRespSingle>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • stockLatestQuoteSingleAsync

      protected okhttp3.Call stockLatestQuoteSingleAsync(String symbol, StockFeed feed, String currency, ApiCallback<StockLatestQuotesRespSingle> _callback) throws ApiException
      Latest quote (single symbol) (asynchronously) The latest quotes endpoint provides the latest bid and ask prices for a given ticker symbol.
      Parameters:
      symbol - The symbol to query for. (required)
      feed - The source feed of the data. `sip` contains all US exchanges, `iex` contains only the Investors Exchange. `otc` contains over the counter exchanges. Default: `sip` for the non-latest endpoints or if the user has the unlimited subscription, `iex` otherwise. (optional, default to sip)
      currency - The currency of all prices in ISO 4217 format. Default is USD. (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object

    • stockLatestQuotesCall

      protected okhttp3.Call stockLatestQuotesCall(String symbols, StockFeed feed, String currency, ApiCallback _callback) throws ApiException
      Build call for stockLatestQuotes
      Parameters:
      symbols - Comma separated list of symbols. (required)
      feed - The source feed of the data. `sip` contains all US exchanges, `iex` contains only the Investors Exchange. `otc` contains over the counter exchanges. Default: `sip` for the non-latest endpoints or if the user has the unlimited subscription, `iex` otherwise. (optional, default to sip)
      currency - The currency of all prices in ISO 4217 format. Default is USD. (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • stockLatestQuotes

      public StockLatestQuotesResp stockLatestQuotes(String symbols, StockFeed feed, String currency) throws ApiException
      Latest quotes The latest multi quotes endpoint provides the latest bid and ask prices for each given ticker symbols.
      Parameters:
      symbols - Comma separated list of symbols. (required)
      feed - The source feed of the data. `sip` contains all US exchanges, `iex` contains only the Investors Exchange. `otc` contains over the counter exchanges. Default: `sip` for the non-latest endpoints or if the user has the unlimited subscription, `iex` otherwise. (optional, default to sip)
      currency - The currency of all prices in ISO 4217 format. Default is USD. (optional)
      Returns:
      StockLatestQuotesResp
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • stockLatestQuotesWithHttpInfo

      protected ApiResponse<StockLatestQuotesResp> stockLatestQuotesWithHttpInfo(String symbols, StockFeed feed, String currency) throws ApiException
      Latest quotes The latest multi quotes endpoint provides the latest bid and ask prices for each given ticker symbols.
      Parameters:
      symbols - Comma separated list of symbols. (required)
      feed - The source feed of the data. `sip` contains all US exchanges, `iex` contains only the Investors Exchange. `otc` contains over the counter exchanges. Default: `sip` for the non-latest endpoints or if the user has the unlimited subscription, `iex` otherwise. (optional, default to sip)
      currency - The currency of all prices in ISO 4217 format. Default is USD. (optional)
      Returns:
      ApiResponse<StockLatestQuotesResp>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • stockLatestQuotesAsync

      protected okhttp3.Call stockLatestQuotesAsync(String symbols, StockFeed feed, String currency, ApiCallback<StockLatestQuotesResp> _callback) throws ApiException
      Latest quotes (asynchronously) The latest multi quotes endpoint provides the latest bid and ask prices for each given ticker symbols.
      Parameters:
      symbols - Comma separated list of symbols. (required)
      feed - The source feed of the data. `sip` contains all US exchanges, `iex` contains only the Investors Exchange. `otc` contains over the counter exchanges. Default: `sip` for the non-latest endpoints or if the user has the unlimited subscription, `iex` otherwise. (optional, default to sip)
      currency - The currency of all prices in ISO 4217 format. Default is USD. (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object

    • stockLatestTradeSingleCall

      protected okhttp3.Call stockLatestTradeSingleCall(String symbol, StockFeed feed, String currency, ApiCallback _callback) throws ApiException
      Build call for stockLatestTradeSingle
      Parameters:
      symbol - The symbol to query for. (required)
      feed - The source feed of the data. `sip` contains all US exchanges, `iex` contains only the Investors Exchange. `otc` contains over the counter exchanges. Default: `sip` for the non-latest endpoints or if the user has the unlimited subscription, `iex` otherwise. (optional, default to sip)
      currency - The currency of all prices in ISO 4217 format. Default is USD. (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • stockLatestTradeSingle

      public StockLatestTradesRespSingle stockLatestTradeSingle(String symbol, StockFeed feed, String currency) throws ApiException
      Latest trade (single symbol) The latest trades endpoint provides the latest trade data for a given ticker symbol.
      Parameters:
      symbol - The symbol to query for. (required)
      feed - The source feed of the data. `sip` contains all US exchanges, `iex` contains only the Investors Exchange. `otc` contains over the counter exchanges. Default: `sip` for the non-latest endpoints or if the user has the unlimited subscription, `iex` otherwise. (optional, default to sip)
      currency - The currency of all prices in ISO 4217 format. Default is USD. (optional)
      Returns:
      StockLatestTradesRespSingle
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • stockLatestTradeSingleWithHttpInfo

      protected ApiResponse<StockLatestTradesRespSingle> stockLatestTradeSingleWithHttpInfo(String symbol, StockFeed feed, String currency) throws ApiException
      Latest trade (single symbol) The latest trades endpoint provides the latest trade data for a given ticker symbol.
      Parameters:
      symbol - The symbol to query for. (required)
      feed - The source feed of the data. `sip` contains all US exchanges, `iex` contains only the Investors Exchange. `otc` contains over the counter exchanges. Default: `sip` for the non-latest endpoints or if the user has the unlimited subscription, `iex` otherwise. (optional, default to sip)
      currency - The currency of all prices in ISO 4217 format. Default is USD. (optional)
      Returns:
      ApiResponse<StockLatestTradesRespSingle>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • stockLatestTradeSingleAsync

      protected okhttp3.Call stockLatestTradeSingleAsync(String symbol, StockFeed feed, String currency, ApiCallback<StockLatestTradesRespSingle> _callback) throws ApiException
      Latest trade (single symbol) (asynchronously) The latest trades endpoint provides the latest trade data for a given ticker symbol.
      Parameters:
      symbol - The symbol to query for. (required)
      feed - The source feed of the data. `sip` contains all US exchanges, `iex` contains only the Investors Exchange. `otc` contains over the counter exchanges. Default: `sip` for the non-latest endpoints or if the user has the unlimited subscription, `iex` otherwise. (optional, default to sip)
      currency - The currency of all prices in ISO 4217 format. Default is USD. (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object

    • stockLatestTradesCall

      protected okhttp3.Call stockLatestTradesCall(String symbols, StockFeed feed, String currency, ApiCallback _callback) throws ApiException
      Build call for stockLatestTrades
      Parameters:
      symbols - Comma separated list of symbols. (required)
      feed - The source feed of the data. `sip` contains all US exchanges, `iex` contains only the Investors Exchange. `otc` contains over the counter exchanges. Default: `sip` for the non-latest endpoints or if the user has the unlimited subscription, `iex` otherwise. (optional, default to sip)
      currency - The currency of all prices in ISO 4217 format. Default is USD. (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • stockLatestTrades

      public StockLatestTradesResp stockLatestTrades(String symbols, StockFeed feed, String currency) throws ApiException
      Latest trades The latest multi trades endpoint provides the latest historical trade data for multiple given ticker symbols.
      Parameters:
      symbols - Comma separated list of symbols. (required)
      feed - The source feed of the data. `sip` contains all US exchanges, `iex` contains only the Investors Exchange. `otc` contains over the counter exchanges. Default: `sip` for the non-latest endpoints or if the user has the unlimited subscription, `iex` otherwise. (optional, default to sip)
      currency - The currency of all prices in ISO 4217 format. Default is USD. (optional)
      Returns:
      StockLatestTradesResp
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • stockLatestTradesWithHttpInfo

      protected ApiResponse<StockLatestTradesResp> stockLatestTradesWithHttpInfo(String symbols, StockFeed feed, String currency) throws ApiException
      Latest trades The latest multi trades endpoint provides the latest historical trade data for multiple given ticker symbols.
      Parameters:
      symbols - Comma separated list of symbols. (required)
      feed - The source feed of the data. `sip` contains all US exchanges, `iex` contains only the Investors Exchange. `otc` contains over the counter exchanges. Default: `sip` for the non-latest endpoints or if the user has the unlimited subscription, `iex` otherwise. (optional, default to sip)
      currency - The currency of all prices in ISO 4217 format. Default is USD. (optional)
      Returns:
      ApiResponse<StockLatestTradesResp>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • stockLatestTradesAsync

      protected okhttp3.Call stockLatestTradesAsync(String symbols, StockFeed feed, String currency, ApiCallback<StockLatestTradesResp> _callback) throws ApiException
      Latest trades (asynchronously) The latest multi trades endpoint provides the latest historical trade data for multiple given ticker symbols.
      Parameters:
      symbols - Comma separated list of symbols. (required)
      feed - The source feed of the data. `sip` contains all US exchanges, `iex` contains only the Investors Exchange. `otc` contains over the counter exchanges. Default: `sip` for the non-latest endpoints or if the user has the unlimited subscription, `iex` otherwise. (optional, default to sip)
      currency - The currency of all prices in ISO 4217 format. Default is USD. (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object

    • stockMetaConditionsCall

      protected okhttp3.Call stockMetaConditionsCall(String ticktype, String tape, ApiCallback _callback) throws ApiException
      Build call for stockMetaConditions
      Parameters:
      ticktype - The type of ticks (required)
      tape - The one character name of the tape (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • stockMetaConditions

      public Map<String,String> stockMetaConditions(String ticktype, String tape) throws ApiException
      Condition codes Returns the mapping between the condition codes and names.
      Parameters:
      ticktype - The type of ticks (required)
      tape - The one character name of the tape (required)
      Returns:
      Map<String, String>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • stockMetaConditionsWithHttpInfo

      protected ApiResponse<Map<String,String>> stockMetaConditionsWithHttpInfo(String ticktype, String tape) throws ApiException
      Condition codes Returns the mapping between the condition codes and names.
      Parameters:
      ticktype - The type of ticks (required)
      tape - The one character name of the tape (required)
      Returns:
      ApiResponse<Map<String, String>>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • stockMetaConditionsAsync

      protected okhttp3.Call stockMetaConditionsAsync(String ticktype, String tape, ApiCallback<Map<String,String>> _callback) throws ApiException
      Condition codes (asynchronously) Returns the mapping between the condition codes and names.
      Parameters:
      ticktype - The type of ticks (required)
      tape - The one character name of the tape (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object

    • stockMetaExchangesCall

      protected okhttp3.Call stockMetaExchangesCall(ApiCallback _callback) throws ApiException
      Build call for stockMetaExchanges
      Parameters:
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • stockMetaExchanges

      public Map<String,String> stockMetaExchanges() throws ApiException
      Exchange codes Returns the mapping between the stock exchange codes and the corresponding exchanges names.
      Returns:
      Map<String, String>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • stockMetaExchangesWithHttpInfo

      protected ApiResponse<Map<String,String>> stockMetaExchangesWithHttpInfo() throws ApiException
      Exchange codes Returns the mapping between the stock exchange codes and the corresponding exchanges names.
      Returns:
      ApiResponse<Map<String, String>>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • stockMetaExchangesAsync

      protected okhttp3.Call stockMetaExchangesAsync(ApiCallback<Map<String,String>> _callback) throws ApiException
      Exchange codes (asynchronously) Returns the mapping between the stock exchange codes and the corresponding exchanges names.
      Parameters:
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object

    • stockQuoteSingleCall

      protected okhttp3.Call stockQuoteSingleCall(String symbol, OffsetDateTime start, OffsetDateTime end, Long limit, String asof, StockFeed feed, String currency, String pageToken, Sort sort, ApiCallback _callback) throws ApiException
      Build call for stockQuoteSingle
      Parameters:
      symbol - The symbol to query for. (required)
      start - The inclusive start of the interval. Format: RFC-3339 or YYYY-MM-DD. If missing, the default value is the beginning of the current day. (optional)
      end - The inclusive end of the interval. Format: RFC-3339 or YYYY-MM-DD. If missing, the default value is the current time. (optional)
      limit - The maximum number of data points to return in the response. The API may return less, even if there are more available data points in the requested interval. Always check the next_page_token for more pages. The limit applies to the total number of data points, not per symbol! (optional, default to 1000)
      asof - The asof date of the queried stock symbol(s) in YYYY-MM-DD format. Default is the current day. This date is used to identify the underlying entity of the provided symbol(s) so that name changes for this entity can be found. Data for past symbol(s) is returned if the query date range spans the name change. The special value of \"-\" means symbol mapping is skipped. Data is returned based on the symbol alone without looking up previous names. The same happens if the queried symbol is not found on the given asof date. Example: FB was renamed to META in 2022-06-09. Querying META with an asof date after 2022-06-09 will also yield FB data. The data for the FB ticker will be labeled as META because they are considered the same underlying entity as of 2022-06-09. Querying FB with an asof date after 2022-06-09 will only return data with the FB ticker, not with META. But with an asof date before 2022-06-09, META will also be returned (as FB). (optional)
      feed - The source feed of the data. `sip` contains all US exchanges, `iex` contains only the Investors Exchange. `otc` contains over the counter exchanges. Default: `sip` for the non-latest endpoints or if the user has the unlimited subscription, `iex` otherwise. (optional, default to sip)
      currency - The currency of all prices in ISO 4217 format. Default is USD. (optional)
      pageToken - Pagination token to continue from. The value to pass here is returned in specific requests when more data is available than the request limit allows. (optional)
      sort - Sort data in ascending or descending order. (optional, default to asc)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • stockQuoteSingle

      public StockQuotesRespSingle stockQuoteSingle(String symbol, OffsetDateTime start, OffsetDateTime end, Long limit, String asof, StockFeed feed, String currency, String pageToken, Sort sort) throws ApiException
      Historical quotes (single symbol) The historical stock quotes API provides quote data for a stock symbol between the specified dates.
      Parameters:
      symbol - The symbol to query for. (required)
      start - The inclusive start of the interval. Format: RFC-3339 or YYYY-MM-DD. If missing, the default value is the beginning of the current day. (optional)
      end - The inclusive end of the interval. Format: RFC-3339 or YYYY-MM-DD. If missing, the default value is the current time. (optional)
      limit - The maximum number of data points to return in the response. The API may return less, even if there are more available data points in the requested interval. Always check the next_page_token for more pages. The limit applies to the total number of data points, not per symbol! (optional, default to 1000)
      asof - The asof date of the queried stock symbol(s) in YYYY-MM-DD format. Default is the current day. This date is used to identify the underlying entity of the provided symbol(s) so that name changes for this entity can be found. Data for past symbol(s) is returned if the query date range spans the name change. The special value of \"-\" means symbol mapping is skipped. Data is returned based on the symbol alone without looking up previous names. The same happens if the queried symbol is not found on the given asof date. Example: FB was renamed to META in 2022-06-09. Querying META with an asof date after 2022-06-09 will also yield FB data. The data for the FB ticker will be labeled as META because they are considered the same underlying entity as of 2022-06-09. Querying FB with an asof date after 2022-06-09 will only return data with the FB ticker, not with META. But with an asof date before 2022-06-09, META will also be returned (as FB). (optional)
      feed - The source feed of the data. `sip` contains all US exchanges, `iex` contains only the Investors Exchange. `otc` contains over the counter exchanges. Default: `sip` for the non-latest endpoints or if the user has the unlimited subscription, `iex` otherwise. (optional, default to sip)
      currency - The currency of all prices in ISO 4217 format. Default is USD. (optional)
      pageToken - Pagination token to continue from. The value to pass here is returned in specific requests when more data is available than the request limit allows. (optional)
      sort - Sort data in ascending or descending order. (optional, default to asc)
      Returns:
      StockQuotesRespSingle
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • stockQuoteSingleWithHttpInfo

      protected ApiResponse<StockQuotesRespSingle> stockQuoteSingleWithHttpInfo(String symbol, OffsetDateTime start, OffsetDateTime end, Long limit, String asof, StockFeed feed, String currency, String pageToken, Sort sort) throws ApiException
      Historical quotes (single symbol) The historical stock quotes API provides quote data for a stock symbol between the specified dates.
      Parameters:
      symbol - The symbol to query for. (required)
      start - The inclusive start of the interval. Format: RFC-3339 or YYYY-MM-DD. If missing, the default value is the beginning of the current day. (optional)
      end - The inclusive end of the interval. Format: RFC-3339 or YYYY-MM-DD. If missing, the default value is the current time. (optional)
      limit - The maximum number of data points to return in the response. The API may return less, even if there are more available data points in the requested interval. Always check the next_page_token for more pages. The limit applies to the total number of data points, not per symbol! (optional, default to 1000)
      asof - The asof date of the queried stock symbol(s) in YYYY-MM-DD format. Default is the current day. This date is used to identify the underlying entity of the provided symbol(s) so that name changes for this entity can be found. Data for past symbol(s) is returned if the query date range spans the name change. The special value of \"-\" means symbol mapping is skipped. Data is returned based on the symbol alone without looking up previous names. The same happens if the queried symbol is not found on the given asof date. Example: FB was renamed to META in 2022-06-09. Querying META with an asof date after 2022-06-09 will also yield FB data. The data for the FB ticker will be labeled as META because they are considered the same underlying entity as of 2022-06-09. Querying FB with an asof date after 2022-06-09 will only return data with the FB ticker, not with META. But with an asof date before 2022-06-09, META will also be returned (as FB). (optional)
      feed - The source feed of the data. `sip` contains all US exchanges, `iex` contains only the Investors Exchange. `otc` contains over the counter exchanges. Default: `sip` for the non-latest endpoints or if the user has the unlimited subscription, `iex` otherwise. (optional, default to sip)
      currency - The currency of all prices in ISO 4217 format. Default is USD. (optional)
      pageToken - Pagination token to continue from. The value to pass here is returned in specific requests when more data is available than the request limit allows. (optional)
      sort - Sort data in ascending or descending order. (optional, default to asc)
      Returns:
      ApiResponse<StockQuotesRespSingle>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • stockQuoteSingleAsync

      protected okhttp3.Call stockQuoteSingleAsync(String symbol, OffsetDateTime start, OffsetDateTime end, Long limit, String asof, StockFeed feed, String currency, String pageToken, Sort sort, ApiCallback<StockQuotesRespSingle> _callback) throws ApiException
      Historical quotes (single symbol) (asynchronously) The historical stock quotes API provides quote data for a stock symbol between the specified dates.
      Parameters:
      symbol - The symbol to query for. (required)
      start - The inclusive start of the interval. Format: RFC-3339 or YYYY-MM-DD. If missing, the default value is the beginning of the current day. (optional)
      end - The inclusive end of the interval. Format: RFC-3339 or YYYY-MM-DD. If missing, the default value is the current time. (optional)
      limit - The maximum number of data points to return in the response. The API may return less, even if there are more available data points in the requested interval. Always check the next_page_token for more pages. The limit applies to the total number of data points, not per symbol! (optional, default to 1000)
      asof - The asof date of the queried stock symbol(s) in YYYY-MM-DD format. Default is the current day. This date is used to identify the underlying entity of the provided symbol(s) so that name changes for this entity can be found. Data for past symbol(s) is returned if the query date range spans the name change. The special value of \"-\" means symbol mapping is skipped. Data is returned based on the symbol alone without looking up previous names. The same happens if the queried symbol is not found on the given asof date. Example: FB was renamed to META in 2022-06-09. Querying META with an asof date after 2022-06-09 will also yield FB data. The data for the FB ticker will be labeled as META because they are considered the same underlying entity as of 2022-06-09. Querying FB with an asof date after 2022-06-09 will only return data with the FB ticker, not with META. But with an asof date before 2022-06-09, META will also be returned (as FB). (optional)
      feed - The source feed of the data. `sip` contains all US exchanges, `iex` contains only the Investors Exchange. `otc` contains over the counter exchanges. Default: `sip` for the non-latest endpoints or if the user has the unlimited subscription, `iex` otherwise. (optional, default to sip)
      currency - The currency of all prices in ISO 4217 format. Default is USD. (optional)
      pageToken - Pagination token to continue from. The value to pass here is returned in specific requests when more data is available than the request limit allows. (optional)
      sort - Sort data in ascending or descending order. (optional, default to asc)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object

    • stockQuotesCall

      protected okhttp3.Call stockQuotesCall(String symbols, OffsetDateTime start, OffsetDateTime end, Long limit, String asof, StockFeed feed, String currency, String pageToken, Sort sort, ApiCallback _callback) throws ApiException
      Build call for stockQuotes
      Parameters:
      symbols - Comma separated list of symbols. (required)
      start - The inclusive start of the interval. Format: RFC-3339 or YYYY-MM-DD. If missing, the default value is the beginning of the current day. (optional)
      end - The inclusive end of the interval. Format: RFC-3339 or YYYY-MM-DD. If missing, the default value is the current time. (optional)
      limit - The maximum number of data points to return in the response. The API may return less, even if there are more available data points in the requested interval. Always check the next_page_token for more pages. The limit applies to the total number of data points, not per symbol! (optional, default to 1000)
      asof - The asof date of the queried stock symbol(s) in YYYY-MM-DD format. Default is the current day. This date is used to identify the underlying entity of the provided symbol(s) so that name changes for this entity can be found. Data for past symbol(s) is returned if the query date range spans the name change. The special value of \"-\" means symbol mapping is skipped. Data is returned based on the symbol alone without looking up previous names. The same happens if the queried symbol is not found on the given asof date. Example: FB was renamed to META in 2022-06-09. Querying META with an asof date after 2022-06-09 will also yield FB data. The data for the FB ticker will be labeled as META because they are considered the same underlying entity as of 2022-06-09. Querying FB with an asof date after 2022-06-09 will only return data with the FB ticker, not with META. But with an asof date before 2022-06-09, META will also be returned (as FB). (optional)
      feed - The source feed of the data. `sip` contains all US exchanges, `iex` contains only the Investors Exchange. `otc` contains over the counter exchanges. Default: `sip` for the non-latest endpoints or if the user has the unlimited subscription, `iex` otherwise. (optional, default to sip)
      currency - The currency of all prices in ISO 4217 format. Default is USD. (optional)
      pageToken - Pagination token to continue from. The value to pass here is returned in specific requests when more data is available than the request limit allows. (optional)
      sort - Sort data in ascending or descending order. (optional, default to asc)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • stockQuotes

      public StockQuotesResp stockQuotes(String symbols, OffsetDateTime start, OffsetDateTime end, Long limit, String asof, StockFeed feed, String currency, String pageToken, Sort sort) throws ApiException
      Historical quotes The historical stock quotes API provides quote data for a list of stock symbols between the specified dates. The returned results are sorted by symbol first then by quote timestamp. This means that you are likely to see only one symbol in your first response if there are enough quotes for that symbol to hit the limit you requested on that request. In these situations if you keep requesting again with the `next_page_token` you will eventually reach the next symbols if any quotes were found for them.
      Parameters:
      symbols - Comma separated list of symbols. (required)
      start - The inclusive start of the interval. Format: RFC-3339 or YYYY-MM-DD. If missing, the default value is the beginning of the current day. (optional)
      end - The inclusive end of the interval. Format: RFC-3339 or YYYY-MM-DD. If missing, the default value is the current time. (optional)
      limit - The maximum number of data points to return in the response. The API may return less, even if there are more available data points in the requested interval. Always check the next_page_token for more pages. The limit applies to the total number of data points, not per symbol! (optional, default to 1000)
      asof - The asof date of the queried stock symbol(s) in YYYY-MM-DD format. Default is the current day. This date is used to identify the underlying entity of the provided symbol(s) so that name changes for this entity can be found. Data for past symbol(s) is returned if the query date range spans the name change. The special value of \"-\" means symbol mapping is skipped. Data is returned based on the symbol alone without looking up previous names. The same happens if the queried symbol is not found on the given asof date. Example: FB was renamed to META in 2022-06-09. Querying META with an asof date after 2022-06-09 will also yield FB data. The data for the FB ticker will be labeled as META because they are considered the same underlying entity as of 2022-06-09. Querying FB with an asof date after 2022-06-09 will only return data with the FB ticker, not with META. But with an asof date before 2022-06-09, META will also be returned (as FB). (optional)
      feed - The source feed of the data. `sip` contains all US exchanges, `iex` contains only the Investors Exchange. `otc` contains over the counter exchanges. Default: `sip` for the non-latest endpoints or if the user has the unlimited subscription, `iex` otherwise. (optional, default to sip)
      currency - The currency of all prices in ISO 4217 format. Default is USD. (optional)
      pageToken - Pagination token to continue from. The value to pass here is returned in specific requests when more data is available than the request limit allows. (optional)
      sort - Sort data in ascending or descending order. (optional, default to asc)
      Returns:
      StockQuotesResp
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • stockQuotesWithHttpInfo

      protected ApiResponse<StockQuotesResp> stockQuotesWithHttpInfo(String symbols, OffsetDateTime start, OffsetDateTime end, Long limit, String asof, StockFeed feed, String currency, String pageToken, Sort sort) throws ApiException
      Historical quotes The historical stock quotes API provides quote data for a list of stock symbols between the specified dates. The returned results are sorted by symbol first then by quote timestamp. This means that you are likely to see only one symbol in your first response if there are enough quotes for that symbol to hit the limit you requested on that request. In these situations if you keep requesting again with the `next_page_token` you will eventually reach the next symbols if any quotes were found for them.
      Parameters:
      symbols - Comma separated list of symbols. (required)
      start - The inclusive start of the interval. Format: RFC-3339 or YYYY-MM-DD. If missing, the default value is the beginning of the current day. (optional)
      end - The inclusive end of the interval. Format: RFC-3339 or YYYY-MM-DD. If missing, the default value is the current time. (optional)
      limit - The maximum number of data points to return in the response. The API may return less, even if there are more available data points in the requested interval. Always check the next_page_token for more pages. The limit applies to the total number of data points, not per symbol! (optional, default to 1000)
      asof - The asof date of the queried stock symbol(s) in YYYY-MM-DD format. Default is the current day. This date is used to identify the underlying entity of the provided symbol(s) so that name changes for this entity can be found. Data for past symbol(s) is returned if the query date range spans the name change. The special value of \"-\" means symbol mapping is skipped. Data is returned based on the symbol alone without looking up previous names. The same happens if the queried symbol is not found on the given asof date. Example: FB was renamed to META in 2022-06-09. Querying META with an asof date after 2022-06-09 will also yield FB data. The data for the FB ticker will be labeled as META because they are considered the same underlying entity as of 2022-06-09. Querying FB with an asof date after 2022-06-09 will only return data with the FB ticker, not with META. But with an asof date before 2022-06-09, META will also be returned (as FB). (optional)
      feed - The source feed of the data. `sip` contains all US exchanges, `iex` contains only the Investors Exchange. `otc` contains over the counter exchanges. Default: `sip` for the non-latest endpoints or if the user has the unlimited subscription, `iex` otherwise. (optional, default to sip)
      currency - The currency of all prices in ISO 4217 format. Default is USD. (optional)
      pageToken - Pagination token to continue from. The value to pass here is returned in specific requests when more data is available than the request limit allows. (optional)
      sort - Sort data in ascending or descending order. (optional, default to asc)
      Returns:
      ApiResponse<StockQuotesResp>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • stockQuotesAsync

      protected okhttp3.Call stockQuotesAsync(String symbols, OffsetDateTime start, OffsetDateTime end, Long limit, String asof, StockFeed feed, String currency, String pageToken, Sort sort, ApiCallback<StockQuotesResp> _callback) throws ApiException
      Historical quotes (asynchronously) The historical stock quotes API provides quote data for a list of stock symbols between the specified dates. The returned results are sorted by symbol first then by quote timestamp. This means that you are likely to see only one symbol in your first response if there are enough quotes for that symbol to hit the limit you requested on that request. In these situations if you keep requesting again with the `next_page_token` you will eventually reach the next symbols if any quotes were found for them.
      Parameters:
      symbols - Comma separated list of symbols. (required)
      start - The inclusive start of the interval. Format: RFC-3339 or YYYY-MM-DD. If missing, the default value is the beginning of the current day. (optional)
      end - The inclusive end of the interval. Format: RFC-3339 or YYYY-MM-DD. If missing, the default value is the current time. (optional)
      limit - The maximum number of data points to return in the response. The API may return less, even if there are more available data points in the requested interval. Always check the next_page_token for more pages. The limit applies to the total number of data points, not per symbol! (optional, default to 1000)
      asof - The asof date of the queried stock symbol(s) in YYYY-MM-DD format. Default is the current day. This date is used to identify the underlying entity of the provided symbol(s) so that name changes for this entity can be found. Data for past symbol(s) is returned if the query date range spans the name change. The special value of \"-\" means symbol mapping is skipped. Data is returned based on the symbol alone without looking up previous names. The same happens if the queried symbol is not found on the given asof date. Example: FB was renamed to META in 2022-06-09. Querying META with an asof date after 2022-06-09 will also yield FB data. The data for the FB ticker will be labeled as META because they are considered the same underlying entity as of 2022-06-09. Querying FB with an asof date after 2022-06-09 will only return data with the FB ticker, not with META. But with an asof date before 2022-06-09, META will also be returned (as FB). (optional)
      feed - The source feed of the data. `sip` contains all US exchanges, `iex` contains only the Investors Exchange. `otc` contains over the counter exchanges. Default: `sip` for the non-latest endpoints or if the user has the unlimited subscription, `iex` otherwise. (optional, default to sip)
      currency - The currency of all prices in ISO 4217 format. Default is USD. (optional)
      pageToken - Pagination token to continue from. The value to pass here is returned in specific requests when more data is available than the request limit allows. (optional)
      sort - Sort data in ascending or descending order. (optional, default to asc)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object

    • stockSnapshotSingleCall

      protected okhttp3.Call stockSnapshotSingleCall(String symbol, StockFeed feed, String currency, ApiCallback _callback) throws ApiException
      Build call for stockSnapshotSingle
      Parameters:
      symbol - The symbol to query for. (required)
      feed - The source feed of the data. `sip` contains all US exchanges, `iex` contains only the Investors Exchange. `otc` contains over the counter exchanges. Default: `sip` for the non-latest endpoints or if the user has the unlimited subscription, `iex` otherwise. (optional, default to sip)
      currency - The currency of all prices in ISO 4217 format. Default is USD. (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • stockSnapshotSingle

      public StockSnapshotsRespSingle stockSnapshotSingle(String symbol, StockFeed feed, String currency) throws ApiException
      Snapshot (single symbol) The snapshot endpoint provides the latest trade, latest quote, minute bar daily bar, and previous daily bar data for a given ticker symbol.
      Parameters:
      symbol - The symbol to query for. (required)
      feed - The source feed of the data. `sip` contains all US exchanges, `iex` contains only the Investors Exchange. `otc` contains over the counter exchanges. Default: `sip` for the non-latest endpoints or if the user has the unlimited subscription, `iex` otherwise. (optional, default to sip)
      currency - The currency of all prices in ISO 4217 format. Default is USD. (optional)
      Returns:
      StockSnapshotsRespSingle
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • stockSnapshotSingleWithHttpInfo

      protected ApiResponse<StockSnapshotsRespSingle> stockSnapshotSingleWithHttpInfo(String symbol, StockFeed feed, String currency) throws ApiException
      Snapshot (single symbol) The snapshot endpoint provides the latest trade, latest quote, minute bar daily bar, and previous daily bar data for a given ticker symbol.
      Parameters:
      symbol - The symbol to query for. (required)
      feed - The source feed of the data. `sip` contains all US exchanges, `iex` contains only the Investors Exchange. `otc` contains over the counter exchanges. Default: `sip` for the non-latest endpoints or if the user has the unlimited subscription, `iex` otherwise. (optional, default to sip)
      currency - The currency of all prices in ISO 4217 format. Default is USD. (optional)
      Returns:
      ApiResponse<StockSnapshotsRespSingle>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • stockSnapshotSingleAsync

      protected okhttp3.Call stockSnapshotSingleAsync(String symbol, StockFeed feed, String currency, ApiCallback<StockSnapshotsRespSingle> _callback) throws ApiException
      Snapshot (single symbol) (asynchronously) The snapshot endpoint provides the latest trade, latest quote, minute bar daily bar, and previous daily bar data for a given ticker symbol.
      Parameters:
      symbol - The symbol to query for. (required)
      feed - The source feed of the data. `sip` contains all US exchanges, `iex` contains only the Investors Exchange. `otc` contains over the counter exchanges. Default: `sip` for the non-latest endpoints or if the user has the unlimited subscription, `iex` otherwise. (optional, default to sip)
      currency - The currency of all prices in ISO 4217 format. Default is USD. (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object

    • stockSnapshotsCall

      protected okhttp3.Call stockSnapshotsCall(String symbols, StockFeed feed, String currency, ApiCallback _callback) throws ApiException
      Build call for stockSnapshots
      Parameters:
      symbols - Comma separated list of symbols. (required)
      feed - The source feed of the data. `sip` contains all US exchanges, `iex` contains only the Investors Exchange. `otc` contains over the counter exchanges. Default: `sip` for the non-latest endpoints or if the user has the unlimited subscription, `iex` otherwise. (optional, default to sip)
      currency - The currency of all prices in ISO 4217 format. Default is USD. (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • stockSnapshots

      public Map<String,StockSnapshot> stockSnapshots(String symbols, StockFeed feed, String currency) throws ApiException
      Snapshots The snapshot endpoint for multiple tickers provides the latest trade, latest quote, minute bar daily bar, and previous daily bar data for each given ticker symbol.
      Parameters:
      symbols - Comma separated list of symbols. (required)
      feed - The source feed of the data. `sip` contains all US exchanges, `iex` contains only the Investors Exchange. `otc` contains over the counter exchanges. Default: `sip` for the non-latest endpoints or if the user has the unlimited subscription, `iex` otherwise. (optional, default to sip)
      currency - The currency of all prices in ISO 4217 format. Default is USD. (optional)
      Returns:
      Map<String, StockSnapshot>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • stockSnapshotsWithHttpInfo

      protected ApiResponse<Map<String,StockSnapshot>> stockSnapshotsWithHttpInfo(String symbols, StockFeed feed, String currency) throws ApiException
      Snapshots The snapshot endpoint for multiple tickers provides the latest trade, latest quote, minute bar daily bar, and previous daily bar data for each given ticker symbol.
      Parameters:
      symbols - Comma separated list of symbols. (required)
      feed - The source feed of the data. `sip` contains all US exchanges, `iex` contains only the Investors Exchange. `otc` contains over the counter exchanges. Default: `sip` for the non-latest endpoints or if the user has the unlimited subscription, `iex` otherwise. (optional, default to sip)
      currency - The currency of all prices in ISO 4217 format. Default is USD. (optional)
      Returns:
      ApiResponse<Map<String, StockSnapshot>>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • stockSnapshotsAsync

      protected okhttp3.Call stockSnapshotsAsync(String symbols, StockFeed feed, String currency, ApiCallback<Map<String,StockSnapshot>> _callback) throws ApiException
      Snapshots (asynchronously) The snapshot endpoint for multiple tickers provides the latest trade, latest quote, minute bar daily bar, and previous daily bar data for each given ticker symbol.
      Parameters:
      symbols - Comma separated list of symbols. (required)
      feed - The source feed of the data. `sip` contains all US exchanges, `iex` contains only the Investors Exchange. `otc` contains over the counter exchanges. Default: `sip` for the non-latest endpoints or if the user has the unlimited subscription, `iex` otherwise. (optional, default to sip)
      currency - The currency of all prices in ISO 4217 format. Default is USD. (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object

    • stockTradeSingleCall

      protected okhttp3.Call stockTradeSingleCall(String symbol, OffsetDateTime start, OffsetDateTime end, Long limit, String asof, StockFeed feed, String currency, String pageToken, Sort sort, ApiCallback _callback) throws ApiException
      Build call for stockTradeSingle
      Parameters:
      symbol - The symbol to query for. (required)
      start - The inclusive start of the interval. Format: RFC-3339 or YYYY-MM-DD. If missing, the default value is the beginning of the current day. (optional)
      end - The inclusive end of the interval. Format: RFC-3339 or YYYY-MM-DD. If missing, the default value is the current time. (optional)
      limit - The maximum number of data points to return in the response. The API may return less, even if there are more available data points in the requested interval. Always check the next_page_token for more pages. The limit applies to the total number of data points, not per symbol! (optional, default to 1000)
      asof - The asof date of the queried stock symbol(s) in YYYY-MM-DD format. Default is the current day. This date is used to identify the underlying entity of the provided symbol(s) so that name changes for this entity can be found. Data for past symbol(s) is returned if the query date range spans the name change. The special value of \"-\" means symbol mapping is skipped. Data is returned based on the symbol alone without looking up previous names. The same happens if the queried symbol is not found on the given asof date. Example: FB was renamed to META in 2022-06-09. Querying META with an asof date after 2022-06-09 will also yield FB data. The data for the FB ticker will be labeled as META because they are considered the same underlying entity as of 2022-06-09. Querying FB with an asof date after 2022-06-09 will only return data with the FB ticker, not with META. But with an asof date before 2022-06-09, META will also be returned (as FB). (optional)
      feed - The source feed of the data. `sip` contains all US exchanges, `iex` contains only the Investors Exchange. `otc` contains over the counter exchanges. Default: `sip` for the non-latest endpoints or if the user has the unlimited subscription, `iex` otherwise. (optional, default to sip)
      currency - The currency of all prices in ISO 4217 format. Default is USD. (optional)
      pageToken - Pagination token to continue from. The value to pass here is returned in specific requests when more data is available than the request limit allows. (optional)
      sort - Sort data in ascending or descending order. (optional, default to asc)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • stockTradeSingle

      public StockTradesRespSingle stockTradeSingle(String symbol, OffsetDateTime start, OffsetDateTime end, Long limit, String asof, StockFeed feed, String currency, String pageToken, Sort sort) throws ApiException
      Historical trades (single symbol) The historical stock trades API provides trade data for a stock symbol between the specified dates.
      Parameters:
      symbol - The symbol to query for. (required)
      start - The inclusive start of the interval. Format: RFC-3339 or YYYY-MM-DD. If missing, the default value is the beginning of the current day. (optional)
      end - The inclusive end of the interval. Format: RFC-3339 or YYYY-MM-DD. If missing, the default value is the current time. (optional)
      limit - The maximum number of data points to return in the response. The API may return less, even if there are more available data points in the requested interval. Always check the next_page_token for more pages. The limit applies to the total number of data points, not per symbol! (optional, default to 1000)
      asof - The asof date of the queried stock symbol(s) in YYYY-MM-DD format. Default is the current day. This date is used to identify the underlying entity of the provided symbol(s) so that name changes for this entity can be found. Data for past symbol(s) is returned if the query date range spans the name change. The special value of \"-\" means symbol mapping is skipped. Data is returned based on the symbol alone without looking up previous names. The same happens if the queried symbol is not found on the given asof date. Example: FB was renamed to META in 2022-06-09. Querying META with an asof date after 2022-06-09 will also yield FB data. The data for the FB ticker will be labeled as META because they are considered the same underlying entity as of 2022-06-09. Querying FB with an asof date after 2022-06-09 will only return data with the FB ticker, not with META. But with an asof date before 2022-06-09, META will also be returned (as FB). (optional)
      feed - The source feed of the data. `sip` contains all US exchanges, `iex` contains only the Investors Exchange. `otc` contains over the counter exchanges. Default: `sip` for the non-latest endpoints or if the user has the unlimited subscription, `iex` otherwise. (optional, default to sip)
      currency - The currency of all prices in ISO 4217 format. Default is USD. (optional)
      pageToken - Pagination token to continue from. The value to pass here is returned in specific requests when more data is available than the request limit allows. (optional)
      sort - Sort data in ascending or descending order. (optional, default to asc)
      Returns:
      StockTradesRespSingle
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • stockTradeSingleWithHttpInfo

      protected ApiResponse<StockTradesRespSingle> stockTradeSingleWithHttpInfo(String symbol, OffsetDateTime start, OffsetDateTime end, Long limit, String asof, StockFeed feed, String currency, String pageToken, Sort sort) throws ApiException
      Historical trades (single symbol) The historical stock trades API provides trade data for a stock symbol between the specified dates.
      Parameters:
      symbol - The symbol to query for. (required)
      start - The inclusive start of the interval. Format: RFC-3339 or YYYY-MM-DD. If missing, the default value is the beginning of the current day. (optional)
      end - The inclusive end of the interval. Format: RFC-3339 or YYYY-MM-DD. If missing, the default value is the current time. (optional)
      limit - The maximum number of data points to return in the response. The API may return less, even if there are more available data points in the requested interval. Always check the next_page_token for more pages. The limit applies to the total number of data points, not per symbol! (optional, default to 1000)
      asof - The asof date of the queried stock symbol(s) in YYYY-MM-DD format. Default is the current day. This date is used to identify the underlying entity of the provided symbol(s) so that name changes for this entity can be found. Data for past symbol(s) is returned if the query date range spans the name change. The special value of \"-\" means symbol mapping is skipped. Data is returned based on the symbol alone without looking up previous names. The same happens if the queried symbol is not found on the given asof date. Example: FB was renamed to META in 2022-06-09. Querying META with an asof date after 2022-06-09 will also yield FB data. The data for the FB ticker will be labeled as META because they are considered the same underlying entity as of 2022-06-09. Querying FB with an asof date after 2022-06-09 will only return data with the FB ticker, not with META. But with an asof date before 2022-06-09, META will also be returned (as FB). (optional)
      feed - The source feed of the data. `sip` contains all US exchanges, `iex` contains only the Investors Exchange. `otc` contains over the counter exchanges. Default: `sip` for the non-latest endpoints or if the user has the unlimited subscription, `iex` otherwise. (optional, default to sip)
      currency - The currency of all prices in ISO 4217 format. Default is USD. (optional)
      pageToken - Pagination token to continue from. The value to pass here is returned in specific requests when more data is available than the request limit allows. (optional)
      sort - Sort data in ascending or descending order. (optional, default to asc)
      Returns:
      ApiResponse<StockTradesRespSingle>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • stockTradeSingleAsync

      protected okhttp3.Call stockTradeSingleAsync(String symbol, OffsetDateTime start, OffsetDateTime end, Long limit, String asof, StockFeed feed, String currency, String pageToken, Sort sort, ApiCallback<StockTradesRespSingle> _callback) throws ApiException
      Historical trades (single symbol) (asynchronously) The historical stock trades API provides trade data for a stock symbol between the specified dates.
      Parameters:
      symbol - The symbol to query for. (required)
      start - The inclusive start of the interval. Format: RFC-3339 or YYYY-MM-DD. If missing, the default value is the beginning of the current day. (optional)
      end - The inclusive end of the interval. Format: RFC-3339 or YYYY-MM-DD. If missing, the default value is the current time. (optional)
      limit - The maximum number of data points to return in the response. The API may return less, even if there are more available data points in the requested interval. Always check the next_page_token for more pages. The limit applies to the total number of data points, not per symbol! (optional, default to 1000)
      asof - The asof date of the queried stock symbol(s) in YYYY-MM-DD format. Default is the current day. This date is used to identify the underlying entity of the provided symbol(s) so that name changes for this entity can be found. Data for past symbol(s) is returned if the query date range spans the name change. The special value of \"-\" means symbol mapping is skipped. Data is returned based on the symbol alone without looking up previous names. The same happens if the queried symbol is not found on the given asof date. Example: FB was renamed to META in 2022-06-09. Querying META with an asof date after 2022-06-09 will also yield FB data. The data for the FB ticker will be labeled as META because they are considered the same underlying entity as of 2022-06-09. Querying FB with an asof date after 2022-06-09 will only return data with the FB ticker, not with META. But with an asof date before 2022-06-09, META will also be returned (as FB). (optional)
      feed - The source feed of the data. `sip` contains all US exchanges, `iex` contains only the Investors Exchange. `otc` contains over the counter exchanges. Default: `sip` for the non-latest endpoints or if the user has the unlimited subscription, `iex` otherwise. (optional, default to sip)
      currency - The currency of all prices in ISO 4217 format. Default is USD. (optional)
      pageToken - Pagination token to continue from. The value to pass here is returned in specific requests when more data is available than the request limit allows. (optional)
      sort - Sort data in ascending or descending order. (optional, default to asc)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object

    • stockTradesCall

      protected okhttp3.Call stockTradesCall(String symbols, OffsetDateTime start, OffsetDateTime end, Long limit, String asof, StockFeed feed, String currency, String pageToken, Sort sort, ApiCallback _callback) throws ApiException
      Build call for stockTrades
      Parameters:
      symbols - Comma separated list of symbols. (required)
      start - The inclusive start of the interval. Format: RFC-3339 or YYYY-MM-DD. If missing, the default value is the beginning of the current day. (optional)
      end - The inclusive end of the interval. Format: RFC-3339 or YYYY-MM-DD. If missing, the default value is the current time. (optional)
      limit - The maximum number of data points to return in the response. The API may return less, even if there are more available data points in the requested interval. Always check the next_page_token for more pages. The limit applies to the total number of data points, not per symbol! (optional, default to 1000)
      asof - The asof date of the queried stock symbol(s) in YYYY-MM-DD format. Default is the current day. This date is used to identify the underlying entity of the provided symbol(s) so that name changes for this entity can be found. Data for past symbol(s) is returned if the query date range spans the name change. The special value of \"-\" means symbol mapping is skipped. Data is returned based on the symbol alone without looking up previous names. The same happens if the queried symbol is not found on the given asof date. Example: FB was renamed to META in 2022-06-09. Querying META with an asof date after 2022-06-09 will also yield FB data. The data for the FB ticker will be labeled as META because they are considered the same underlying entity as of 2022-06-09. Querying FB with an asof date after 2022-06-09 will only return data with the FB ticker, not with META. But with an asof date before 2022-06-09, META will also be returned (as FB). (optional)
      feed - The source feed of the data. `sip` contains all US exchanges, `iex` contains only the Investors Exchange. `otc` contains over the counter exchanges. Default: `sip` for the non-latest endpoints or if the user has the unlimited subscription, `iex` otherwise. (optional, default to sip)
      currency - The currency of all prices in ISO 4217 format. Default is USD. (optional)
      pageToken - Pagination token to continue from. The value to pass here is returned in specific requests when more data is available than the request limit allows. (optional)
      sort - Sort data in ascending or descending order. (optional, default to asc)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • stockTrades

      public StockTradesResp stockTrades(String symbols, OffsetDateTime start, OffsetDateTime end, Long limit, String asof, StockFeed feed, String currency, String pageToken, Sort sort) throws ApiException
      Historical trades The historical stock trades API provides trade data for a list of stock symbols between the specified dates. The returned results are sorted by symbol first then by trade timestamp. This means that you are likely to see only one symbol in your first response if there are enough trades for that symbol to hit the limit you requested on that request. In these situations if you keep requesting again with the `next_page_token` you will eventually reach the next symbols if any trades were found for them.
      Parameters:
      symbols - Comma separated list of symbols. (required)
      start - The inclusive start of the interval. Format: RFC-3339 or YYYY-MM-DD. If missing, the default value is the beginning of the current day. (optional)
      end - The inclusive end of the interval. Format: RFC-3339 or YYYY-MM-DD. If missing, the default value is the current time. (optional)
      limit - The maximum number of data points to return in the response. The API may return less, even if there are more available data points in the requested interval. Always check the next_page_token for more pages. The limit applies to the total number of data points, not per symbol! (optional, default to 1000)
      asof - The asof date of the queried stock symbol(s) in YYYY-MM-DD format. Default is the current day. This date is used to identify the underlying entity of the provided symbol(s) so that name changes for this entity can be found. Data for past symbol(s) is returned if the query date range spans the name change. The special value of \"-\" means symbol mapping is skipped. Data is returned based on the symbol alone without looking up previous names. The same happens if the queried symbol is not found on the given asof date. Example: FB was renamed to META in 2022-06-09. Querying META with an asof date after 2022-06-09 will also yield FB data. The data for the FB ticker will be labeled as META because they are considered the same underlying entity as of 2022-06-09. Querying FB with an asof date after 2022-06-09 will only return data with the FB ticker, not with META. But with an asof date before 2022-06-09, META will also be returned (as FB). (optional)
      feed - The source feed of the data. `sip` contains all US exchanges, `iex` contains only the Investors Exchange. `otc` contains over the counter exchanges. Default: `sip` for the non-latest endpoints or if the user has the unlimited subscription, `iex` otherwise. (optional, default to sip)
      currency - The currency of all prices in ISO 4217 format. Default is USD. (optional)
      pageToken - Pagination token to continue from. The value to pass here is returned in specific requests when more data is available than the request limit allows. (optional)
      sort - Sort data in ascending or descending order. (optional, default to asc)
      Returns:
      StockTradesResp
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • stockTradesWithHttpInfo

      protected ApiResponse<StockTradesResp> stockTradesWithHttpInfo(String symbols, OffsetDateTime start, OffsetDateTime end, Long limit, String asof, StockFeed feed, String currency, String pageToken, Sort sort) throws ApiException
      Historical trades The historical stock trades API provides trade data for a list of stock symbols between the specified dates. The returned results are sorted by symbol first then by trade timestamp. This means that you are likely to see only one symbol in your first response if there are enough trades for that symbol to hit the limit you requested on that request. In these situations if you keep requesting again with the `next_page_token` you will eventually reach the next symbols if any trades were found for them.
      Parameters:
      symbols - Comma separated list of symbols. (required)
      start - The inclusive start of the interval. Format: RFC-3339 or YYYY-MM-DD. If missing, the default value is the beginning of the current day. (optional)
      end - The inclusive end of the interval. Format: RFC-3339 or YYYY-MM-DD. If missing, the default value is the current time. (optional)
      limit - The maximum number of data points to return in the response. The API may return less, even if there are more available data points in the requested interval. Always check the next_page_token for more pages. The limit applies to the total number of data points, not per symbol! (optional, default to 1000)
      asof - The asof date of the queried stock symbol(s) in YYYY-MM-DD format. Default is the current day. This date is used to identify the underlying entity of the provided symbol(s) so that name changes for this entity can be found. Data for past symbol(s) is returned if the query date range spans the name change. The special value of \"-\" means symbol mapping is skipped. Data is returned based on the symbol alone without looking up previous names. The same happens if the queried symbol is not found on the given asof date. Example: FB was renamed to META in 2022-06-09. Querying META with an asof date after 2022-06-09 will also yield FB data. The data for the FB ticker will be labeled as META because they are considered the same underlying entity as of 2022-06-09. Querying FB with an asof date after 2022-06-09 will only return data with the FB ticker, not with META. But with an asof date before 2022-06-09, META will also be returned (as FB). (optional)
      feed - The source feed of the data. `sip` contains all US exchanges, `iex` contains only the Investors Exchange. `otc` contains over the counter exchanges. Default: `sip` for the non-latest endpoints or if the user has the unlimited subscription, `iex` otherwise. (optional, default to sip)
      currency - The currency of all prices in ISO 4217 format. Default is USD. (optional)
      pageToken - Pagination token to continue from. The value to pass here is returned in specific requests when more data is available than the request limit allows. (optional)
      sort - Sort data in ascending or descending order. (optional, default to asc)
      Returns:
      ApiResponse<StockTradesResp>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • stockTradesAsync

      protected okhttp3.Call stockTradesAsync(String symbols, OffsetDateTime start, OffsetDateTime end, Long limit, String asof, StockFeed feed, String currency, String pageToken, Sort sort, ApiCallback<StockTradesResp> _callback) throws ApiException
      Historical trades (asynchronously) The historical stock trades API provides trade data for a list of stock symbols between the specified dates. The returned results are sorted by symbol first then by trade timestamp. This means that you are likely to see only one symbol in your first response if there are enough trades for that symbol to hit the limit you requested on that request. In these situations if you keep requesting again with the `next_page_token` you will eventually reach the next symbols if any trades were found for them.
      Parameters:
      symbols - Comma separated list of symbols. (required)
      start - The inclusive start of the interval. Format: RFC-3339 or YYYY-MM-DD. If missing, the default value is the beginning of the current day. (optional)
      end - The inclusive end of the interval. Format: RFC-3339 or YYYY-MM-DD. If missing, the default value is the current time. (optional)
      limit - The maximum number of data points to return in the response. The API may return less, even if there are more available data points in the requested interval. Always check the next_page_token for more pages. The limit applies to the total number of data points, not per symbol! (optional, default to 1000)
      asof - The asof date of the queried stock symbol(s) in YYYY-MM-DD format. Default is the current day. This date is used to identify the underlying entity of the provided symbol(s) so that name changes for this entity can be found. Data for past symbol(s) is returned if the query date range spans the name change. The special value of \"-\" means symbol mapping is skipped. Data is returned based on the symbol alone without looking up previous names. The same happens if the queried symbol is not found on the given asof date. Example: FB was renamed to META in 2022-06-09. Querying META with an asof date after 2022-06-09 will also yield FB data. The data for the FB ticker will be labeled as META because they are considered the same underlying entity as of 2022-06-09. Querying FB with an asof date after 2022-06-09 will only return data with the FB ticker, not with META. But with an asof date before 2022-06-09, META will also be returned (as FB). (optional)
      feed - The source feed of the data. `sip` contains all US exchanges, `iex` contains only the Investors Exchange. `otc` contains over the counter exchanges. Default: `sip` for the non-latest endpoints or if the user has the unlimited subscription, `iex` otherwise. (optional, default to sip)
      currency - The currency of all prices in ISO 4217 format. Default is USD. (optional)
      pageToken - Pagination token to continue from. The value to pass here is returned in specific requests when more data is available than the request limit allows. (optional)
      sort - Sort data in ascending or descending order. (optional, default to asc)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object