Package markets.alpaca.client.openapi.trading.api

Class LocatesApi

java.lang.Object

markets.alpaca.client.openapi.trading.api.LocatesApi

public class LocatesApi
extends Object

Generated client for LocatesApi operations.

This class is generated from the configured OpenAPI spec. Operation method Javadocs include OAS summaries, descriptions, parameters, return types, response details, and external documentation links when present in the spec.

Operations

• createLocates: Create Locate
• getLocate: Get Locate
• listLocateQuotes: Get Locate Quotes
• listLocates: List Locates

Constructor Summary

Constructors

Constructor	Description
LocatesApi()
LocatesApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
Locate	createLocates(CreateLocateRequest createLocateRequest)	Create Locate Creates a locate request for a short sale.
okhttp3.Call	createLocatesAsync(CreateLocateRequest createLocateRequest, ApiCallback<Locate> _callback)	Create Locate (asynchronously) Creates a locate request for a short sale.
okhttp3.Call	createLocatesCall(CreateLocateRequest createLocateRequest, ApiCallback _callback)	Build call for createLocates
ApiResponse<Locate>	createLocatesWithHttpInfo(CreateLocateRequest createLocateRequest)	Create Locate Creates a locate request for a short sale.
ApiClient	getApiClient()
String	getCustomBaseUrl()
int	getHostIndex()
Locate	getLocate(UUID locateId)	Get Locate Returns a locate by ID.
okhttp3.Call	getLocateAsync(UUID locateId, ApiCallback<Locate> _callback)	Get Locate (asynchronously) Returns a locate by ID.
okhttp3.Call	getLocateCall(UUID locateId, ApiCallback _callback)	Build call for getLocate
ApiResponse<Locate>	getLocateWithHttpInfo(UUID locateId)	Get Locate Returns a locate by ID.
ListLocateQuotesResponse	listLocateQuotes(String symbols)	Get Locate Quotes Returns locate availability and pricing for one or more symbols.
okhttp3.Call	listLocateQuotesAsync(String symbols, ApiCallback<ListLocateQuotesResponse> _callback)	Get Locate Quotes (asynchronously) Returns locate availability and pricing for one or more symbols.
okhttp3.Call	listLocateQuotesCall(String symbols, ApiCallback _callback)	Build call for listLocateQuotes
ApiResponse<ListLocateQuotesResponse>	listLocateQuotesWithHttpInfo(String symbols)	Get Locate Quotes Returns locate availability and pricing for one or more symbols.
ListLocatesResponse	listLocates(String pageToken, Integer limit, LocateStatus status, String symbol, LocalDate start, LocalDate end)	List Locates Returns locates filtered by status, symbol, or date range.
okhttp3.Call	listLocatesAsync(String pageToken, Integer limit, LocateStatus status, String symbol, LocalDate start, LocalDate end, ApiCallback<ListLocatesResponse> _callback)	List Locates (asynchronously) Returns locates filtered by status, symbol, or date range.
okhttp3.Call	listLocatesCall(String pageToken, Integer limit, LocateStatus status, String symbol, LocalDate start, LocalDate end, ApiCallback _callback)	Build call for listLocates
ApiResponse<ListLocatesResponse>	listLocatesWithHttpInfo(String pageToken, Integer limit, LocateStatus status, String symbol, LocalDate start, LocalDate end)	List Locates Returns locates filtered by status, symbol, or date range.
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(String customBaseUrl)
void	setHostIndex(int hostIndex)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

LocatesApi

public LocatesApi()

LocatesApi

public LocatesApi(ApiClient apiClient)

Method Details

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getHostIndex

public int getHostIndex()

setHostIndex

public void setHostIndex(int hostIndex)

getCustomBaseUrl

public String getCustomBaseUrl()

setCustomBaseUrl

public void setCustomBaseUrl(String customBaseUrl)

createLocatesCall

public okhttp3.Call createLocatesCall(@Nonnull
 CreateLocateRequest createLocateRequest,
 ApiCallback _callback)
                               throws ApiException

Build call for createLocates

Parameters:

createLocateRequest - Locate request details. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

HTTP Response Details:

Response Details

Status Code	Description	Response Headers
201	Created	-
400	Invalid locate request.	-
401	Authentication headers are missing or invalid. Make sure you authenticate your request with a valid API key.	-
403	User has no access to a resource.	-
422	Cannot complete locate request.	-
500	Internal server error. We recommend retrying these later. If the issue persists, please contact us on Slack or on the Community Forum.	-

createLocates

public Locate createLocates(@Nonnull
 CreateLocateRequest createLocateRequest)
                     throws ApiException

Create Locate Creates a locate request for a short sale.

Parameters:

createLocateRequest - Locate request details. (required)

Returns:

Locate

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

HTTP Response Details:

Response Details

Status Code	Description	Response Headers
201	Created	-
400	Invalid locate request.	-
401	Authentication headers are missing or invalid. Make sure you authenticate your request with a valid API key.	-
403	User has no access to a resource.	-
422	Cannot complete locate request.	-
500	Internal server error. We recommend retrying these later. If the issue persists, please contact us on Slack or on the Community Forum.	-

createLocatesWithHttpInfo

public ApiResponse<Locate> createLocatesWithHttpInfo(@Nonnull
 CreateLocateRequest createLocateRequest)
                                              throws ApiException

Create Locate Creates a locate request for a short sale.

Parameters:

createLocateRequest - Locate request details. (required)

Returns:

ApiResponse<Locate>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

HTTP Response Details:

Response Details

Status Code	Description	Response Headers
201	Created	-
400	Invalid locate request.	-
401	Authentication headers are missing or invalid. Make sure you authenticate your request with a valid API key.	-
403	User has no access to a resource.	-
422	Cannot complete locate request.	-
500	Internal server error. We recommend retrying these later. If the issue persists, please contact us on Slack or on the Community Forum.	-

createLocatesAsync

public okhttp3.Call createLocatesAsync(@Nonnull
 CreateLocateRequest createLocateRequest,
 ApiCallback<Locate> _callback)
                                throws ApiException

Create Locate (asynchronously) Creates a locate request for a short sale.

Parameters:

createLocateRequest - Locate request details. (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

HTTP Response Details:

Response Details

Status Code	Description	Response Headers
201	Created	-
400	Invalid locate request.	-
401	Authentication headers are missing or invalid. Make sure you authenticate your request with a valid API key.	-
403	User has no access to a resource.	-
422	Cannot complete locate request.	-
500	Internal server error. We recommend retrying these later. If the issue persists, please contact us on Slack or on the Community Forum.	-

getLocateCall

public okhttp3.Call getLocateCall(@Nonnull
 UUID locateId,
 ApiCallback _callback)
                           throws ApiException

Build call for getLocate

Parameters:

locateId - The locate ID. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

HTTP Response Details:

Response Details

Status Code	Description	Response Headers
200	Returns the requested locate.	-
400	Invalid locate request.	-
401	Authentication headers are missing or invalid. Make sure you authenticate your request with a valid API key.	-
403	User has no access to a resource.	-
404	Not found	-
500	Internal server error. We recommend retrying these later. If the issue persists, please contact us on Slack or on the Community Forum.	-

getLocate

public Locate getLocate(@Nonnull
 UUID locateId)
                 throws ApiException

Get Locate Returns a locate by ID.

Parameters:

locateId - The locate ID. (required)

Returns:

Locate

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

HTTP Response Details:

Response Details

Status Code	Description	Response Headers
200	Returns the requested locate.	-
400	Invalid locate request.	-
401	Authentication headers are missing or invalid. Make sure you authenticate your request with a valid API key.	-
403	User has no access to a resource.	-
404	Not found	-
500	Internal server error. We recommend retrying these later. If the issue persists, please contact us on Slack or on the Community Forum.	-

getLocateWithHttpInfo

public ApiResponse<Locate> getLocateWithHttpInfo(@Nonnull
 UUID locateId)
                                          throws ApiException

Get Locate Returns a locate by ID.

Parameters:

locateId - The locate ID. (required)

Returns:

ApiResponse<Locate>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

HTTP Response Details:

Response Details

Status Code	Description	Response Headers
200	Returns the requested locate.	-
400	Invalid locate request.	-
401	Authentication headers are missing or invalid. Make sure you authenticate your request with a valid API key.	-
403	User has no access to a resource.	-
404	Not found	-
500	Internal server error. We recommend retrying these later. If the issue persists, please contact us on Slack or on the Community Forum.	-

getLocateAsync

public okhttp3.Call getLocateAsync(@Nonnull
 UUID locateId,
 ApiCallback<Locate> _callback)
                            throws ApiException

Get Locate (asynchronously) Returns a locate by ID.

Parameters:

locateId - The locate ID. (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

HTTP Response Details:

Response Details

Status Code	Description	Response Headers
200	Returns the requested locate.	-
400	Invalid locate request.	-
401	Authentication headers are missing or invalid. Make sure you authenticate your request with a valid API key.	-
403	User has no access to a resource.	-
404	Not found	-
500	Internal server error. We recommend retrying these later. If the issue persists, please contact us on Slack or on the Community Forum.	-

listLocateQuotesCall

public okhttp3.Call listLocateQuotesCall(@Nonnull
 String symbols,
 ApiCallback _callback)
                                  throws ApiException

Build call for listLocateQuotes

Parameters:

symbols - Comma-separated list of stock symbols. Maximum 100 unique symbols. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

HTTP Response Details:

Response Details

Status Code	Description	Response Headers
200	Returns locate quotes for the requested symbols.	-
400	Invalid locate quote request.	-
401	Authentication headers are missing or invalid. Make sure you authenticate your request with a valid API key.	-
403	User has no access to a resource.	-
500	Internal server error. We recommend retrying these later. If the issue persists, please contact us on Slack or on the Community Forum.	-

listLocateQuotes

public ListLocateQuotesResponse listLocateQuotes(@Nonnull
 String symbols)
                                          throws ApiException

Get Locate Quotes Returns locate availability and pricing for one or more symbols.

Parameters:

symbols - Comma-separated list of stock symbols. Maximum 100 unique symbols. (required)

Returns:

ListLocateQuotesResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

HTTP Response Details:

Response Details

Status Code	Description	Response Headers
200	Returns locate quotes for the requested symbols.	-
400	Invalid locate quote request.	-
401	Authentication headers are missing or invalid. Make sure you authenticate your request with a valid API key.	-
403	User has no access to a resource.	-
500	Internal server error. We recommend retrying these later. If the issue persists, please contact us on Slack or on the Community Forum.	-

listLocateQuotesWithHttpInfo

public ApiResponse<ListLocateQuotesResponse> listLocateQuotesWithHttpInfo(@Nonnull
 String symbols)
                                                                   throws ApiException

Get Locate Quotes Returns locate availability and pricing for one or more symbols.

Parameters:

symbols - Comma-separated list of stock symbols. Maximum 100 unique symbols. (required)

Returns:

ApiResponse<ListLocateQuotesResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

HTTP Response Details:

Response Details

Status Code	Description	Response Headers
200	Returns locate quotes for the requested symbols.	-
400	Invalid locate quote request.	-
401	Authentication headers are missing or invalid. Make sure you authenticate your request with a valid API key.	-
403	User has no access to a resource.	-
500	Internal server error. We recommend retrying these later. If the issue persists, please contact us on Slack or on the Community Forum.	-

listLocateQuotesAsync

public okhttp3.Call listLocateQuotesAsync(@Nonnull
 String symbols,
 ApiCallback<ListLocateQuotesResponse> _callback)
                                   throws ApiException

Get Locate Quotes (asynchronously) Returns locate availability and pricing for one or more symbols.

Parameters:

symbols - Comma-separated list of stock symbols. Maximum 100 unique symbols. (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

HTTP Response Details:

Response Details

Status Code	Description	Response Headers
200	Returns locate quotes for the requested symbols.	-
400	Invalid locate quote request.	-
401	Authentication headers are missing or invalid. Make sure you authenticate your request with a valid API key.	-
403	User has no access to a resource.	-
500	Internal server error. We recommend retrying these later. If the issue persists, please contact us on Slack or on the Community Forum.	-

listLocatesCall

public okhttp3.Call listLocatesCall(@Nullable
 String pageToken,
 @Nullable
 Integer limit,
 @Nullable
 LocateStatus status,
 @Nullable
 String symbol,
 @Nullable
 LocalDate start,
 @Nullable
 LocalDate end,
 ApiCallback _callback)
                             throws ApiException

Build call for listLocates

Parameters:

pageToken - Used for pagination, this token retrieves the next page of results. It is obtained from the response of the preceding page when additional pages are available. (optional)

limit - Maximum number of results to return. (optional, default to 1000)

status - Filter by locate status. (optional)

symbol - Filter by stock symbol. (optional)

start - Filter locates with locate trading date on or after this date. Format: YYYY-MM-DD. The locate trading date uses America/New_York and rolls at 8pm ET. (optional)

end - Filter locates with locate trading date before this date (exclusive). Format: YYYY-MM-DD. The locate trading date uses America/New_York and rolls at 8pm ET. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

HTTP Response Details:

Response Details

Status Code	Description	Response Headers
200	Returns a list of locates for the account, or an empty list if no locates are found.	-
400	Invalid locate request.	-
401	Authentication headers are missing or invalid. Make sure you authenticate your request with a valid API key.	-
403	User has no access to a resource.	-
500	Internal server error. We recommend retrying these later. If the issue persists, please contact us on Slack or on the Community Forum.	-

listLocates

public ListLocatesResponse listLocates(@Nullable
 String pageToken,
 @Nullable
 Integer limit,
 @Nullable
 LocateStatus status,
 @Nullable
 String symbol,
 @Nullable
 LocalDate start,
 @Nullable
 LocalDate end)
                                throws ApiException

List Locates Returns locates filtered by status, symbol, or date range. Results are sorted by `created_at` descending, with `id` descending as the tie-breaker.

Parameters:

pageToken - Used for pagination, this token retrieves the next page of results. It is obtained from the response of the preceding page when additional pages are available. (optional)

limit - Maximum number of results to return. (optional, default to 1000)

status - Filter by locate status. (optional)

symbol - Filter by stock symbol. (optional)

start - Filter locates with locate trading date on or after this date. Format: YYYY-MM-DD. The locate trading date uses America/New_York and rolls at 8pm ET. (optional)

end - Filter locates with locate trading date before this date (exclusive). Format: YYYY-MM-DD. The locate trading date uses America/New_York and rolls at 8pm ET. (optional)

Returns:

ListLocatesResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

HTTP Response Details:

Response Details

Status Code	Description	Response Headers
200	Returns a list of locates for the account, or an empty list if no locates are found.	-
400	Invalid locate request.	-
401	Authentication headers are missing or invalid. Make sure you authenticate your request with a valid API key.	-
403	User has no access to a resource.	-
500	Internal server error. We recommend retrying these later. If the issue persists, please contact us on Slack or on the Community Forum.	-

listLocatesWithHttpInfo

public ApiResponse<ListLocatesResponse> listLocatesWithHttpInfo(@Nullable
 String pageToken,
 @Nullable
 Integer limit,
 @Nullable
 LocateStatus status,
 @Nullable
 String symbol,
 @Nullable
 LocalDate start,
 @Nullable
 LocalDate end)
                                                         throws ApiException

List Locates Returns locates filtered by status, symbol, or date range. Results are sorted by `created_at` descending, with `id` descending as the tie-breaker.

Parameters:

pageToken - Used for pagination, this token retrieves the next page of results. It is obtained from the response of the preceding page when additional pages are available. (optional)

limit - Maximum number of results to return. (optional, default to 1000)

status - Filter by locate status. (optional)

symbol - Filter by stock symbol. (optional)

start - Filter locates with locate trading date on or after this date. Format: YYYY-MM-DD. The locate trading date uses America/New_York and rolls at 8pm ET. (optional)

end - Filter locates with locate trading date before this date (exclusive). Format: YYYY-MM-DD. The locate trading date uses America/New_York and rolls at 8pm ET. (optional)

Returns:

ApiResponse<ListLocatesResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

HTTP Response Details:

Response Details

Status Code	Description	Response Headers
200	Returns a list of locates for the account, or an empty list if no locates are found.	-
400	Invalid locate request.	-
401	Authentication headers are missing or invalid. Make sure you authenticate your request with a valid API key.	-
403	User has no access to a resource.	-
500	Internal server error. We recommend retrying these later. If the issue persists, please contact us on Slack or on the Community Forum.	-

listLocatesAsync

public okhttp3.Call listLocatesAsync(@Nullable
 String pageToken,
 @Nullable
 Integer limit,
 @Nullable
 LocateStatus status,
 @Nullable
 String symbol,
 @Nullable
 LocalDate start,
 @Nullable
 LocalDate end,
 ApiCallback<ListLocatesResponse> _callback)
                              throws ApiException

List Locates (asynchronously) Returns locates filtered by status, symbol, or date range. Results are sorted by `created_at` descending, with `id` descending as the tie-breaker.

Parameters:

pageToken - Used for pagination, this token retrieves the next page of results. It is obtained from the response of the preceding page when additional pages are available. (optional)

limit - Maximum number of results to return. (optional, default to 1000)

status - Filter by locate status. (optional)

symbol - Filter by stock symbol. (optional)

start - Filter locates with locate trading date on or after this date. Format: YYYY-MM-DD. The locate trading date uses America/New_York and rolls at 8pm ET. (optional)

end - Filter locates with locate trading date before this date (exclusive). Format: YYYY-MM-DD. The locate trading date uses America/New_York and rolls at 8pm ET. (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

HTTP Response Details:

Response Details

Status Code	Description	Response Headers
200	Returns a list of locates for the account, or an empty list if no locates are found.	-
400	Invalid locate request.	-
401	Authentication headers are missing or invalid. Make sure you authenticate your request with a valid API key.	-
403	User has no access to a resource.	-
500	Internal server error. We recommend retrying these later. If the issue persists, please contact us on Slack or on the Community Forum.	-