java.lang.Object
net.jacobpeterson.alpaca.openapi.marketdata.api.OptionApi

public class OptionApi extends Object
  • Constructor Details

    • OptionApi

      public OptionApi()
    • OptionApi

      public OptionApi(ApiClient apiClient)
  • Method Details

    • optionBarsCall

      protected okhttp3.Call optionBarsCall(String symbols, String timeframe, OffsetDateTime start, OffsetDateTime end, Long limit, String pageToken, Sort sort, ApiCallback _callback) throws ApiException
      Build call for optionBars
      Parameters:
      symbols - Comma separated list of contract symbols with a limit of 100. (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)
      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
    • optionBars

      public OptionBarsResp optionBars(String symbols, String timeframe, OffsetDateTime start, OffsetDateTime end, Long limit, String pageToken, Sort sort) throws ApiException
      Historical bars The historical option bars API provides aggregates for a list of option 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 contract symbols with a limit of 100. (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)
      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:
      OptionBarsResp
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
    • optionBarsWithHttpInfo

      protected ApiResponse<OptionBarsResp> optionBarsWithHttpInfo(String symbols, String timeframe, OffsetDateTime start, OffsetDateTime end, Long limit, String pageToken, Sort sort) throws ApiException
      Historical bars The historical option bars API provides aggregates for a list of option 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 contract symbols with a limit of 100. (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)
      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<OptionBarsResp>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
    • optionBarsAsync

      protected okhttp3.Call optionBarsAsync(String symbols, String timeframe, OffsetDateTime start, OffsetDateTime end, Long limit, String pageToken, Sort sort, ApiCallback<OptionBarsResp> _callback) throws ApiException
      Historical bars (asynchronously) The historical option bars API provides aggregates for a list of option 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 contract symbols with a limit of 100. (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)
      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
    • optionChainCall

      protected okhttp3.Call optionChainCall(String underlyingSymbol, OptionFeed feed, ApiCallback _callback) throws ApiException
      Build call for optionChain
      Parameters:
      underlyingSymbol - The financial instrument on which an option contract is based or derived. (required)
      feed - The source feed of the data. `opra` is the official OPRA feed, `indicative` is a free indicative feed where trades are delayed and quotes are modified. Default: `opra` if the user has a subscription, `indicative` otherwise. (optional, default to opra)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
    • optionChain

      public OptionSnapshotsResp optionChain(String underlyingSymbol, OptionFeed feed) throws ApiException
      Option chain The option chain endpoint for underlying symbol provides the latest trade, latest quote for each contract symbol of the underlying symbol.
      Parameters:
      underlyingSymbol - The financial instrument on which an option contract is based or derived. (required)
      feed - The source feed of the data. `opra` is the official OPRA feed, `indicative` is a free indicative feed where trades are delayed and quotes are modified. Default: `opra` if the user has a subscription, `indicative` otherwise. (optional, default to opra)
      Returns:
      OptionSnapshotsResp
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
    • optionChainWithHttpInfo

      protected ApiResponse<OptionSnapshotsResp> optionChainWithHttpInfo(String underlyingSymbol, OptionFeed feed) throws ApiException
      Option chain The option chain endpoint for underlying symbol provides the latest trade, latest quote for each contract symbol of the underlying symbol.
      Parameters:
      underlyingSymbol - The financial instrument on which an option contract is based or derived. (required)
      feed - The source feed of the data. `opra` is the official OPRA feed, `indicative` is a free indicative feed where trades are delayed and quotes are modified. Default: `opra` if the user has a subscription, `indicative` otherwise. (optional, default to opra)
      Returns:
      ApiResponse<OptionSnapshotsResp>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
    • optionChainAsync

      protected okhttp3.Call optionChainAsync(String underlyingSymbol, OptionFeed feed, ApiCallback<OptionSnapshotsResp> _callback) throws ApiException
      Option chain (asynchronously) The option chain endpoint for underlying symbol provides the latest trade, latest quote for each contract symbol of the underlying symbol.
      Parameters:
      underlyingSymbol - The financial instrument on which an option contract is based or derived. (required)
      feed - The source feed of the data. `opra` is the official OPRA feed, `indicative` is a free indicative feed where trades are delayed and quotes are modified. Default: `opra` if the user has a subscription, `indicative` otherwise. (optional, default to opra)
      _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
    • optionLatestQuotesCall

      protected okhttp3.Call optionLatestQuotesCall(String symbols, OptionFeed feed, ApiCallback _callback) throws ApiException
      Build call for optionLatestQuotes
      Parameters:
      symbols - Comma separated list of contract symbols with a limit of 100. (required)
      feed - The source feed of the data. `opra` is the official OPRA feed, `indicative` is a free indicative feed where trades are delayed and quotes are modified. Default: `opra` if the user has a subscription, `indicative` otherwise. (optional, default to opra)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
    • optionLatestQuotes

      public OptionLatestQuotesResp optionLatestQuotes(String symbols, OptionFeed feed) throws ApiException
      Latest quotes The latest multi quotes endpoint provides the latest bid and ask prices for each given contract symbol.
      Parameters:
      symbols - Comma separated list of contract symbols with a limit of 100. (required)
      feed - The source feed of the data. `opra` is the official OPRA feed, `indicative` is a free indicative feed where trades are delayed and quotes are modified. Default: `opra` if the user has a subscription, `indicative` otherwise. (optional, default to opra)
      Returns:
      OptionLatestQuotesResp
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
    • optionLatestQuotesWithHttpInfo

      protected ApiResponse<OptionLatestQuotesResp> optionLatestQuotesWithHttpInfo(String symbols, OptionFeed feed) throws ApiException
      Latest quotes The latest multi quotes endpoint provides the latest bid and ask prices for each given contract symbol.
      Parameters:
      symbols - Comma separated list of contract symbols with a limit of 100. (required)
      feed - The source feed of the data. `opra` is the official OPRA feed, `indicative` is a free indicative feed where trades are delayed and quotes are modified. Default: `opra` if the user has a subscription, `indicative` otherwise. (optional, default to opra)
      Returns:
      ApiResponse<OptionLatestQuotesResp>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
    • optionLatestQuotesAsync

      protected okhttp3.Call optionLatestQuotesAsync(String symbols, OptionFeed feed, ApiCallback<OptionLatestQuotesResp> _callback) throws ApiException
      Latest quotes (asynchronously) The latest multi quotes endpoint provides the latest bid and ask prices for each given contract symbol.
      Parameters:
      symbols - Comma separated list of contract symbols with a limit of 100. (required)
      feed - The source feed of the data. `opra` is the official OPRA feed, `indicative` is a free indicative feed where trades are delayed and quotes are modified. Default: `opra` if the user has a subscription, `indicative` otherwise. (optional, default to opra)
      _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
    • optionLatestTradesCall

      protected okhttp3.Call optionLatestTradesCall(String symbols, OptionFeed feed, ApiCallback _callback) throws ApiException
      Build call for optionLatestTrades
      Parameters:
      symbols - Comma separated list of contract symbols with a limit of 100. (required)
      feed - The source feed of the data. `opra` is the official OPRA feed, `indicative` is a free indicative feed where trades are delayed and quotes are modified. Default: `opra` if the user has a subscription, `indicative` otherwise. (optional, default to opra)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
    • optionLatestTrades

      public OptionLatestTradesResp optionLatestTrades(String symbols, OptionFeed feed) throws ApiException
      Latest trades The latest multi trades endpoint provides the latest historical trade data for multiple given contract symbols.
      Parameters:
      symbols - Comma separated list of contract symbols with a limit of 100. (required)
      feed - The source feed of the data. `opra` is the official OPRA feed, `indicative` is a free indicative feed where trades are delayed and quotes are modified. Default: `opra` if the user has a subscription, `indicative` otherwise. (optional, default to opra)
      Returns:
      OptionLatestTradesResp
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
    • optionLatestTradesWithHttpInfo

      protected ApiResponse<OptionLatestTradesResp> optionLatestTradesWithHttpInfo(String symbols, OptionFeed feed) throws ApiException
      Latest trades The latest multi trades endpoint provides the latest historical trade data for multiple given contract symbols.
      Parameters:
      symbols - Comma separated list of contract symbols with a limit of 100. (required)
      feed - The source feed of the data. `opra` is the official OPRA feed, `indicative` is a free indicative feed where trades are delayed and quotes are modified. Default: `opra` if the user has a subscription, `indicative` otherwise. (optional, default to opra)
      Returns:
      ApiResponse<OptionLatestTradesResp>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
    • optionLatestTradesAsync

      protected okhttp3.Call optionLatestTradesAsync(String symbols, OptionFeed feed, ApiCallback<OptionLatestTradesResp> _callback) throws ApiException
      Latest trades (asynchronously) The latest multi trades endpoint provides the latest historical trade data for multiple given contract symbols.
      Parameters:
      symbols - Comma separated list of contract symbols with a limit of 100. (required)
      feed - The source feed of the data. `opra` is the official OPRA feed, `indicative` is a free indicative feed where trades are delayed and quotes are modified. Default: `opra` if the user has a subscription, `indicative` otherwise. (optional, default to opra)
      _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
    • optionMetaExchangesCall

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

      public Map<String,String> optionMetaExchanges() throws ApiException
      Exchange codes Returns the mapping between the option 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
    • optionMetaExchangesWithHttpInfo

      protected ApiResponse<Map<String,String>> optionMetaExchangesWithHttpInfo() throws ApiException
      Exchange codes Returns the mapping between the option 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
    • optionMetaExchangesAsync

      protected okhttp3.Call optionMetaExchangesAsync(ApiCallback<Map<String,String>> _callback) throws ApiException
      Exchange codes (asynchronously) Returns the mapping between the option 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
    • optionSnapshotsCall

      protected okhttp3.Call optionSnapshotsCall(String symbols, OptionFeed feed, ApiCallback _callback) throws ApiException
      Build call for optionSnapshots
      Parameters:
      symbols - Comma separated list of contract symbols with a limit of 100. (required)
      feed - The source feed of the data. `opra` is the official OPRA feed, `indicative` is a free indicative feed where trades are delayed and quotes are modified. Default: `opra` if the user has a subscription, `indicative` otherwise. (optional, default to opra)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
    • optionSnapshots

      public OptionSnapshotsResp optionSnapshots(String symbols, OptionFeed feed) throws ApiException
      Snapshots The snapshot endpoint for multiple contract symbol provides the latest trade, latest quote for each given symbol.
      Parameters:
      symbols - Comma separated list of contract symbols with a limit of 100. (required)
      feed - The source feed of the data. `opra` is the official OPRA feed, `indicative` is a free indicative feed where trades are delayed and quotes are modified. Default: `opra` if the user has a subscription, `indicative` otherwise. (optional, default to opra)
      Returns:
      OptionSnapshotsResp
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
    • optionSnapshotsWithHttpInfo

      protected ApiResponse<OptionSnapshotsResp> optionSnapshotsWithHttpInfo(String symbols, OptionFeed feed) throws ApiException
      Snapshots The snapshot endpoint for multiple contract symbol provides the latest trade, latest quote for each given symbol.
      Parameters:
      symbols - Comma separated list of contract symbols with a limit of 100. (required)
      feed - The source feed of the data. `opra` is the official OPRA feed, `indicative` is a free indicative feed where trades are delayed and quotes are modified. Default: `opra` if the user has a subscription, `indicative` otherwise. (optional, default to opra)
      Returns:
      ApiResponse<OptionSnapshotsResp>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
    • optionSnapshotsAsync

      protected okhttp3.Call optionSnapshotsAsync(String symbols, OptionFeed feed, ApiCallback<OptionSnapshotsResp> _callback) throws ApiException
      Snapshots (asynchronously) The snapshot endpoint for multiple contract symbol provides the latest trade, latest quote for each given symbol.
      Parameters:
      symbols - Comma separated list of contract symbols with a limit of 100. (required)
      feed - The source feed of the data. `opra` is the official OPRA feed, `indicative` is a free indicative feed where trades are delayed and quotes are modified. Default: `opra` if the user has a subscription, `indicative` otherwise. (optional, default to opra)
      _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
    • optionTradesCall

      protected okhttp3.Call optionTradesCall(String symbols, OffsetDateTime start, OffsetDateTime end, Long limit, String pageToken, Sort sort, ApiCallback _callback) throws ApiException
      Build call for optionTrades
      Parameters:
      symbols - Comma separated list of contract symbols with a limit of 100. (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)
      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
    • optionTrades

      public OptionTradesResp optionTrades(String symbols, OffsetDateTime start, OffsetDateTime end, Long limit, String pageToken, Sort sort) throws ApiException
      Historical trades The historical option trades API provides trade data for a list of contract symbols between the specified dates up to 7 days ago. 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 contract symbols with a limit of 100. (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)
      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:
      OptionTradesResp
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
    • optionTradesWithHttpInfo

      protected ApiResponse<OptionTradesResp> optionTradesWithHttpInfo(String symbols, OffsetDateTime start, OffsetDateTime end, Long limit, String pageToken, Sort sort) throws ApiException
      Historical trades The historical option trades API provides trade data for a list of contract symbols between the specified dates up to 7 days ago. 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 contract symbols with a limit of 100. (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)
      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<OptionTradesResp>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
    • optionTradesAsync

      protected okhttp3.Call optionTradesAsync(String symbols, OffsetDateTime start, OffsetDateTime end, Long limit, String pageToken, Sort sort, ApiCallback<OptionTradesResp> _callback) throws ApiException
      Historical trades (asynchronously) The historical option trades API provides trade data for a list of contract symbols between the specified dates up to 7 days ago. 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 contract symbols with a limit of 100. (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)
      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