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

Class TokenizationApi

java.lang.Object

markets.alpaca.client.openapi.trading.api.TokenizationApi

public class TokenizationApi
extends Object

Generated client for TokenizationApi 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

• getTokenizationRequests: List Tokenization Requests
• postTokenizationMint: Mint a Tokenized Asset

Constructor Summary

Constructors

Constructor	Description
TokenizationApi()
TokenizationApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ApiClient	getApiClient()
String	getCustomBaseUrl()
int	getHostIndex()
List<TokenizationRequest>	getTokenizationRequests(TokenizationRequestType type, TokenizationRequestStatus status, String underlyingSymbol, String issuer, TokenizationNetwork network, OffsetDateTime after, OffsetDateTime before)	List Tokenization Requests An Authorized Participant can use this endpoint to list the tokenization requests performed on the Instant Tokenization Network (ITN).
okhttp3.Call	getTokenizationRequestsAsync(TokenizationRequestType type, TokenizationRequestStatus status, String underlyingSymbol, String issuer, TokenizationNetwork network, OffsetDateTime after, OffsetDateTime before, ApiCallback<List<TokenizationRequest>> _callback)	List Tokenization Requests (asynchronously) An Authorized Participant can use this endpoint to list the tokenization requests performed on the Instant Tokenization Network (ITN).
okhttp3.Call	getTokenizationRequestsCall(TokenizationRequestType type, TokenizationRequestStatus status, String underlyingSymbol, String issuer, TokenizationNetwork network, OffsetDateTime after, OffsetDateTime before, ApiCallback _callback)	Build call for getTokenizationRequests
ApiResponse<List<TokenizationRequest>>	getTokenizationRequestsWithHttpInfo(TokenizationRequestType type, TokenizationRequestStatus status, String underlyingSymbol, String issuer, TokenizationNetwork network, OffsetDateTime after, OffsetDateTime before)	List Tokenization Requests An Authorized Participant can use this endpoint to list the tokenization requests performed on the Instant Tokenization Network (ITN).
TokenizationMintResponse	postTokenizationMint(TokenizationMintRequest tokenizationMintRequest)	Mint a Tokenized Asset This endpoint is used by an Authorized Participant to request the minting of a tokenized asset.
okhttp3.Call	postTokenizationMintAsync(TokenizationMintRequest tokenizationMintRequest, ApiCallback<TokenizationMintResponse> _callback)	Mint a Tokenized Asset (asynchronously) This endpoint is used by an Authorized Participant to request the minting of a tokenized asset.
okhttp3.Call	postTokenizationMintCall(TokenizationMintRequest tokenizationMintRequest, ApiCallback _callback)	Build call for postTokenizationMint
ApiResponse<TokenizationMintResponse>	postTokenizationMintWithHttpInfo(TokenizationMintRequest tokenizationMintRequest)	Mint a Tokenized Asset This endpoint is used by an Authorized Participant to request the minting of a tokenized asset.
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

TokenizationApi

public TokenizationApi()

TokenizationApi

public TokenizationApi(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)

getTokenizationRequestsCall

public okhttp3.Call getTokenizationRequestsCall(@Nullable
 TokenizationRequestType type,
 @Nullable
 TokenizationRequestStatus status,
 @Nullable
 String underlyingSymbol,
 @Nullable
 String issuer,
 @Nullable
 TokenizationNetwork network,
 @Nullable
 OffsetDateTime after,
 @Nullable
 OffsetDateTime before,
 ApiCallback _callback)
                                         throws ApiException

Build call for getTokenizationRequests

Parameters:

type - Tokenization request type to be queried (optional)

status - Tokenization request status to be queried (optional)

underlyingSymbol - Underlying symbol of the tokenization requests to be queried (optional)

issuer - Issuer of the tokenization requests to be queried (optional)

network - Network of the tokenization requests to be queried (optional)

after - The response will include only requests created after this timestamp (exclusive) (optional)

before - The response will include only requests created before this timestamp (exclusive) (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	Successful response A list of tokenization requests	-
401	Authentication credentials are missing or invalid.	-
403	Caller is not authorized to perform this operation.	-
422	One or more request parameters are missing or invalid.	-

getTokenizationRequests

public List<TokenizationRequest> getTokenizationRequests(@Nullable
 TokenizationRequestType type,
 @Nullable
 TokenizationRequestStatus status,
 @Nullable
 String underlyingSymbol,
 @Nullable
 String issuer,
 @Nullable
 TokenizationNetwork network,
 @Nullable
 OffsetDateTime after,
 @Nullable
 OffsetDateTime before)
                                                  throws ApiException

List Tokenization Requests An Authorized Participant can use this endpoint to list the tokenization requests performed on the Instant Tokenization Network (ITN).

Parameters:

type - Tokenization request type to be queried (optional)

status - Tokenization request status to be queried (optional)

underlyingSymbol - Underlying symbol of the tokenization requests to be queried (optional)

issuer - Issuer of the tokenization requests to be queried (optional)

network - Network of the tokenization requests to be queried (optional)

after - The response will include only requests created after this timestamp (exclusive) (optional)

before - The response will include only requests created before this timestamp (exclusive) (optional)

Returns:

List<TokenizationRequest>

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	Successful response A list of tokenization requests	-
401	Authentication credentials are missing or invalid.	-
403	Caller is not authorized to perform this operation.	-
422	One or more request parameters are missing or invalid.	-

getTokenizationRequestsWithHttpInfo

public ApiResponse<List<TokenizationRequest>> getTokenizationRequestsWithHttpInfo(@Nullable
 TokenizationRequestType type,
 @Nullable
 TokenizationRequestStatus status,
 @Nullable
 String underlyingSymbol,
 @Nullable
 String issuer,
 @Nullable
 TokenizationNetwork network,
 @Nullable
 OffsetDateTime after,
 @Nullable
 OffsetDateTime before)
                                                                           throws ApiException

List Tokenization Requests An Authorized Participant can use this endpoint to list the tokenization requests performed on the Instant Tokenization Network (ITN).

Parameters:

type - Tokenization request type to be queried (optional)

status - Tokenization request status to be queried (optional)

underlyingSymbol - Underlying symbol of the tokenization requests to be queried (optional)

issuer - Issuer of the tokenization requests to be queried (optional)

network - Network of the tokenization requests to be queried (optional)

after - The response will include only requests created after this timestamp (exclusive) (optional)

before - The response will include only requests created before this timestamp (exclusive) (optional)

Returns:

ApiResponse<List<TokenizationRequest>>

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	Successful response A list of tokenization requests	-
401	Authentication credentials are missing or invalid.	-
403	Caller is not authorized to perform this operation.	-
422	One or more request parameters are missing or invalid.	-

getTokenizationRequestsAsync

public okhttp3.Call getTokenizationRequestsAsync(@Nullable
 TokenizationRequestType type,
 @Nullable
 TokenizationRequestStatus status,
 @Nullable
 String underlyingSymbol,
 @Nullable
 String issuer,
 @Nullable
 TokenizationNetwork network,
 @Nullable
 OffsetDateTime after,
 @Nullable
 OffsetDateTime before,
 ApiCallback<List<TokenizationRequest>> _callback)
                                          throws ApiException

List Tokenization Requests (asynchronously) An Authorized Participant can use this endpoint to list the tokenization requests performed on the Instant Tokenization Network (ITN).

Parameters:

type - Tokenization request type to be queried (optional)

status - Tokenization request status to be queried (optional)

underlyingSymbol - Underlying symbol of the tokenization requests to be queried (optional)

issuer - Issuer of the tokenization requests to be queried (optional)

network - Network of the tokenization requests to be queried (optional)

after - The response will include only requests created after this timestamp (exclusive) (optional)

before - The response will include only requests created before this timestamp (exclusive) (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	Successful response A list of tokenization requests	-
401	Authentication credentials are missing or invalid.	-
403	Caller is not authorized to perform this operation.	-
422	One or more request parameters are missing or invalid.	-

postTokenizationMintCall

public okhttp3.Call postTokenizationMintCall(@Nonnull
 TokenizationMintRequest tokenizationMintRequest,
 ApiCallback _callback)
                                      throws ApiException

Build call for postTokenizationMint

Parameters:

tokenizationMintRequest - (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	Successfully requested minting of a tokenized asset.	-
400	Bad request (e.g. malformed input, insufficient position, or account not authorized to mint).	-
401	Authentication credentials are missing or invalid.	-
403	Caller is not authorized to perform this operation.	-
422	One or more request parameters are missing or invalid.	-

postTokenizationMint

public TokenizationMintResponse postTokenizationMint(@Nonnull
 TokenizationMintRequest tokenizationMintRequest)
                                              throws ApiException

Mint a Tokenized Asset This endpoint is used by an Authorized Participant to request the minting of a tokenized asset.

Parameters:

tokenizationMintRequest - (required)

Returns:

TokenizationMintResponse

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	Successfully requested minting of a tokenized asset.	-
400	Bad request (e.g. malformed input, insufficient position, or account not authorized to mint).	-
401	Authentication credentials are missing or invalid.	-
403	Caller is not authorized to perform this operation.	-
422	One or more request parameters are missing or invalid.	-

postTokenizationMintWithHttpInfo

public ApiResponse<TokenizationMintResponse> postTokenizationMintWithHttpInfo(@Nonnull
 TokenizationMintRequest tokenizationMintRequest)
                                                                       throws ApiException

Mint a Tokenized Asset This endpoint is used by an Authorized Participant to request the minting of a tokenized asset.

Parameters:

tokenizationMintRequest - (required)

Returns:

ApiResponse<TokenizationMintResponse>

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	Successfully requested minting of a tokenized asset.	-
400	Bad request (e.g. malformed input, insufficient position, or account not authorized to mint).	-
401	Authentication credentials are missing or invalid.	-
403	Caller is not authorized to perform this operation.	-
422	One or more request parameters are missing or invalid.	-

postTokenizationMintAsync

public okhttp3.Call postTokenizationMintAsync(@Nonnull
 TokenizationMintRequest tokenizationMintRequest,
 ApiCallback<TokenizationMintResponse> _callback)
                                       throws ApiException

Mint a Tokenized Asset (asynchronously) This endpoint is used by an Authorized Participant to request the minting of a tokenized asset.

Parameters:

tokenizationMintRequest - (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	Successfully requested minting of a tokenized asset.	-
400	Bad request (e.g. malformed input, insufficient position, or account not authorized to mint).	-
401	Authentication credentials are missing or invalid.	-
403	Caller is not authorized to perform this operation.	-
422	One or more request parameters are missing or invalid.	-