Class TokenizationApi
java.lang.Object
markets.alpaca.client.openapi.trading.api.TokenizationApi
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
getTokenizationRequest: Get Tokenization Request by IDgetTokenizationRequestByClientRequestID: Get Tokenization Request by `client_request_id`getTokenizationRequests: List Tokenization RequestspostTokenizationMint: Mint a Tokenized Asset
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionintgetTokenizationRequest(UUID tokenizationRequestId) Get Tokenization Request by ID An Authorized Participant can use this endpoint to retrieve a single tokenization request, mint or redeem, by its `tokenization_request_id`.okhttp3.CallgetTokenizationRequestAsync(UUID tokenizationRequestId, ApiCallback<TokenizationRequest> _callback) Get Tokenization Request by ID (asynchronously) An Authorized Participant can use this endpoint to retrieve a single tokenization request, mint or redeem, by its `tokenization_request_id`.getTokenizationRequestByClientRequestID(String clientRequestId) Get Tokenization Request by `client_request_id` An Authorized Participant can use this endpoint to retrieve a single mint tokenization request by their own `client_request_id` -- the AP-supplied label originally passed on the mint request.okhttp3.CallgetTokenizationRequestByClientRequestIDAsync(String clientRequestId, ApiCallback<TokenizationRequest> _callback) Get Tokenization Request by `client_request_id` (asynchronously) An Authorized Participant can use this endpoint to retrieve a single mint tokenization request by their own `client_request_id` -- the AP-supplied label originally passed on the mint request.okhttp3.CallgetTokenizationRequestByClientRequestIDCall(String clientRequestId, ApiCallback _callback) Build call for getTokenizationRequestByClientRequestIDgetTokenizationRequestByClientRequestIDWithHttpInfo(String clientRequestId) Get Tokenization Request by `client_request_id` An Authorized Participant can use this endpoint to retrieve a single mint tokenization request by their own `client_request_id` -- the AP-supplied label originally passed on the mint request.okhttp3.CallgetTokenizationRequestCall(UUID tokenizationRequestId, ApiCallback _callback) Build call for getTokenizationRequestgetTokenizationRequests(TokenizationRequestType type, TokenizationRequestStatus status, String underlyingSymbol, TokenizationIssuer 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.CallgetTokenizationRequestsAsync(TokenizationRequestType type, TokenizationRequestStatus status, String underlyingSymbol, TokenizationIssuer 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.CallgetTokenizationRequestsCall(TokenizationRequestType type, TokenizationRequestStatus status, String underlyingSymbol, TokenizationIssuer issuer, TokenizationNetwork network, OffsetDateTime after, OffsetDateTime before, ApiCallback _callback) Build call for getTokenizationRequestsgetTokenizationRequestsWithHttpInfo(TokenizationRequestType type, TokenizationRequestStatus status, String underlyingSymbol, TokenizationIssuer 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).getTokenizationRequestWithHttpInfo(UUID tokenizationRequestId) Get Tokenization Request by ID An Authorized Participant can use this endpoint to retrieve a single tokenization request, mint or redeem, by its `tokenization_request_id`.postTokenizationMint(TokenizationMintRequest tokenizationMintRequest, String idempotencyKey) Mint a Tokenized Asset This endpoint is used by an Authorized Participant to request the minting of a tokenized asset.okhttp3.CallpostTokenizationMintAsync(TokenizationMintRequest tokenizationMintRequest, String idempotencyKey, 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.CallpostTokenizationMintCall(TokenizationMintRequest tokenizationMintRequest, String idempotencyKey, ApiCallback _callback) Build call for postTokenizationMintpostTokenizationMintWithHttpInfo(TokenizationMintRequest tokenizationMintRequest, String idempotencyKey) Mint a Tokenized Asset This endpoint is used by an Authorized Participant to request the minting of a tokenized asset.voidsetApiClient(ApiClient apiClient) voidsetCustomBaseUrl(String customBaseUrl) voidsetHostIndex(int hostIndex)
-
Constructor Details
-
TokenizationApi
public TokenizationApi() -
TokenizationApi
-
-
Method Details
-
getApiClient
-
setApiClient
-
getHostIndex
public int getHostIndex() -
setHostIndex
public void setHostIndex(int hostIndex) -
getCustomBaseUrl
-
setCustomBaseUrl
-
getTokenizationRequestCall
public okhttp3.Call getTokenizationRequestCall(@Nonnull UUID tokenizationRequestId, ApiCallback _callback) throws ApiException Build call for getTokenizationRequest- Parameters:
tokenizationRequestId- Unique identifier of the tokenization request, as returned by the mint endpoint or the list-requests endpoint. (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 Successful response - 401 Authentication credentials are missing or invalid. - 403 Caller is not authorized to perform this operation. - 404 No tokenization request with the supplied `tokenization_request_id` exists for the calling account. - 422 The `tokenization_request_id` path parameter is not a valid UUID. -
-
getTokenizationRequest
public TokenizationRequest getTokenizationRequest(@Nonnull UUID tokenizationRequestId) throws ApiException Get Tokenization Request by ID An Authorized Participant can use this endpoint to retrieve a single tokenization request, mint or redeem, by its `tokenization_request_id`.- Parameters:
tokenizationRequestId- Unique identifier of the tokenization request, as returned by the mint endpoint or the list-requests endpoint. (required)- Returns:
- 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 - 401 Authentication credentials are missing or invalid. - 403 Caller is not authorized to perform this operation. - 404 No tokenization request with the supplied `tokenization_request_id` exists for the calling account. - 422 The `tokenization_request_id` path parameter is not a valid UUID. -
-
getTokenizationRequestWithHttpInfo
public ApiResponse<TokenizationRequest> getTokenizationRequestWithHttpInfo(@Nonnull UUID tokenizationRequestId) throws ApiException Get Tokenization Request by ID An Authorized Participant can use this endpoint to retrieve a single tokenization request, mint or redeem, by its `tokenization_request_id`.- Parameters:
tokenizationRequestId- Unique identifier of the tokenization request, as returned by the mint endpoint or the list-requests endpoint. (required)- Returns:
- ApiResponse<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 - 401 Authentication credentials are missing or invalid. - 403 Caller is not authorized to perform this operation. - 404 No tokenization request with the supplied `tokenization_request_id` exists for the calling account. - 422 The `tokenization_request_id` path parameter is not a valid UUID. -
-
getTokenizationRequestAsync
public okhttp3.Call getTokenizationRequestAsync(@Nonnull UUID tokenizationRequestId, ApiCallback<TokenizationRequest> _callback) throws ApiException Get Tokenization Request by ID (asynchronously) An Authorized Participant can use this endpoint to retrieve a single tokenization request, mint or redeem, by its `tokenization_request_id`.- Parameters:
tokenizationRequestId- Unique identifier of the tokenization request, as returned by the mint endpoint or the list-requests endpoint. (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 Successful response - 401 Authentication credentials are missing or invalid. - 403 Caller is not authorized to perform this operation. - 404 No tokenization request with the supplied `tokenization_request_id` exists for the calling account. - 422 The `tokenization_request_id` path parameter is not a valid UUID. -
-
getTokenizationRequestByClientRequestIDCall
public okhttp3.Call getTokenizationRequestByClientRequestIDCall(@Nonnull String clientRequestId, ApiCallback _callback) throws ApiException Build call for getTokenizationRequestByClientRequestID- Parameters:
clientRequestId- AP-supplied request identifier originally passed on the mint request, echoed back on the tokenization-request response. (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 Successful response - 401 Authentication credentials are missing or invalid. - 403 Caller is not authorized to perform this operation. - 404 No tokenization request with the supplied `client_request_id` exists for the calling account. - 422 The `client_request_id` query parameter is missing. -
-
getTokenizationRequestByClientRequestID
public TokenizationRequest getTokenizationRequestByClientRequestID(@Nonnull String clientRequestId) throws ApiException Get Tokenization Request by `client_request_id` An Authorized Participant can use this endpoint to retrieve a single mint tokenization request by their own `client_request_id` -- the AP-supplied label originally passed on the mint request. If the AP has reused a `client_request_id` across multiple requests, the most recently created request is returned.- Parameters:
clientRequestId- AP-supplied request identifier originally passed on the mint request, echoed back on the tokenization-request response. (required)- Returns:
- 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 - 401 Authentication credentials are missing or invalid. - 403 Caller is not authorized to perform this operation. - 404 No tokenization request with the supplied `client_request_id` exists for the calling account. - 422 The `client_request_id` query parameter is missing. -
-
getTokenizationRequestByClientRequestIDWithHttpInfo
public ApiResponse<TokenizationRequest> getTokenizationRequestByClientRequestIDWithHttpInfo(@Nonnull String clientRequestId) throws ApiException Get Tokenization Request by `client_request_id` An Authorized Participant can use this endpoint to retrieve a single mint tokenization request by their own `client_request_id` -- the AP-supplied label originally passed on the mint request. If the AP has reused a `client_request_id` across multiple requests, the most recently created request is returned.- Parameters:
clientRequestId- AP-supplied request identifier originally passed on the mint request, echoed back on the tokenization-request response. (required)- Returns:
- ApiResponse<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 - 401 Authentication credentials are missing or invalid. - 403 Caller is not authorized to perform this operation. - 404 No tokenization request with the supplied `client_request_id` exists for the calling account. - 422 The `client_request_id` query parameter is missing. -
-
getTokenizationRequestByClientRequestIDAsync
public okhttp3.Call getTokenizationRequestByClientRequestIDAsync(@Nonnull String clientRequestId, ApiCallback<TokenizationRequest> _callback) throws ApiException Get Tokenization Request by `client_request_id` (asynchronously) An Authorized Participant can use this endpoint to retrieve a single mint tokenization request by their own `client_request_id` -- the AP-supplied label originally passed on the mint request. If the AP has reused a `client_request_id` across multiple requests, the most recently created request is returned.- Parameters:
clientRequestId- AP-supplied request identifier originally passed on the mint request, echoed back on the tokenization-request response. (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 Successful response - 401 Authentication credentials are missing or invalid. - 403 Caller is not authorized to perform this operation. - 404 No tokenization request with the supplied `client_request_id` exists for the calling account. - 422 The `client_request_id` query parameter is missing. -
-
getTokenizationRequestsCall
public okhttp3.Call getTokenizationRequestsCall(@Nullable TokenizationRequestType type, @Nullable TokenizationRequestStatus status, @Nullable String underlyingSymbol, @Nullable TokenizationIssuer 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 TokenizationIssuer 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 TokenizationIssuer 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 TokenizationIssuer 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, @Nullable String idempotencyKey, ApiCallback _callback) throws ApiException Build call for postTokenizationMint- Parameters:
tokenizationMintRequest- (required)idempotencyKey- Optional client-generated key for safe retries and duplicate request detection. This endpoint currently accepts keys up to 128 characters. Alpaca is moving toward a 36-character maximum; new implementations should generate a unique UUIDv7 or UUIDv4 value (36 characters including hyphens) for each logical operation. Do not reuse a key across operations. (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 Successfully requested minting of a tokenized asset. - 400 Bad request (e.g. malformed input, insufficient position, or account not authorized to mint). Also returned when the `Idempotency-Key` header is malformed, or when replaying a request that was originally rejected. - 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, or the same `Idempotency-Key` was reused with a different request body. -
-
postTokenizationMint
public TokenizationMintResponse postTokenizationMint(@Nonnull TokenizationMintRequest tokenizationMintRequest, @Nullable String idempotencyKey) throws ApiException Mint a Tokenized Asset This endpoint is used by an Authorized Participant to request the minting of a tokenized asset. **Idempotency**: When the `Idempotency-Key` header is supplied, this endpoint is idempotent. Multiple requests with the same key and identical request body will create only one mint request. A subsequent request returns the previously created request with the same response (no duplicate is created). If the same key is used with a different request body, the API returns `422 Unprocessable Entity`. **Recommended for production**: Always supply `Idempotency-Key` when requesting a mint. This allows safe retries on timeouts, network errors, or 5xx responses without risking duplicate requests. Use a client-generated unique value (e.g. UUID).- Parameters:
tokenizationMintRequest- (required)idempotencyKey- Optional client-generated key for safe retries and duplicate request detection. This endpoint currently accepts keys up to 128 characters. Alpaca is moving toward a 36-character maximum; new implementations should generate a unique UUIDv7 or UUIDv4 value (36 characters including hyphens) for each logical operation. Do not reuse a key across operations. (optional)- 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). Also returned when the `Idempotency-Key` header is malformed, or when replaying a request that was originally rejected. - 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, or the same `Idempotency-Key` was reused with a different request body. -
-
postTokenizationMintWithHttpInfo
public ApiResponse<TokenizationMintResponse> postTokenizationMintWithHttpInfo(@Nonnull TokenizationMintRequest tokenizationMintRequest, @Nullable String idempotencyKey) throws ApiException Mint a Tokenized Asset This endpoint is used by an Authorized Participant to request the minting of a tokenized asset. **Idempotency**: When the `Idempotency-Key` header is supplied, this endpoint is idempotent. Multiple requests with the same key and identical request body will create only one mint request. A subsequent request returns the previously created request with the same response (no duplicate is created). If the same key is used with a different request body, the API returns `422 Unprocessable Entity`. **Recommended for production**: Always supply `Idempotency-Key` when requesting a mint. This allows safe retries on timeouts, network errors, or 5xx responses without risking duplicate requests. Use a client-generated unique value (e.g. UUID).- Parameters:
tokenizationMintRequest- (required)idempotencyKey- Optional client-generated key for safe retries and duplicate request detection. This endpoint currently accepts keys up to 128 characters. Alpaca is moving toward a 36-character maximum; new implementations should generate a unique UUIDv7 or UUIDv4 value (36 characters including hyphens) for each logical operation. Do not reuse a key across operations. (optional)- 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). Also returned when the `Idempotency-Key` header is malformed, or when replaying a request that was originally rejected. - 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, or the same `Idempotency-Key` was reused with a different request body. -
-
postTokenizationMintAsync
public okhttp3.Call postTokenizationMintAsync(@Nonnull TokenizationMintRequest tokenizationMintRequest, @Nullable String idempotencyKey, 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. **Idempotency**: When the `Idempotency-Key` header is supplied, this endpoint is idempotent. Multiple requests with the same key and identical request body will create only one mint request. A subsequent request returns the previously created request with the same response (no duplicate is created). If the same key is used with a different request body, the API returns `422 Unprocessable Entity`. **Recommended for production**: Always supply `Idempotency-Key` when requesting a mint. This allows safe retries on timeouts, network errors, or 5xx responses without risking duplicate requests. Use a client-generated unique value (e.g. UUID).- Parameters:
tokenizationMintRequest- (required)idempotencyKey- Optional client-generated key for safe retries and duplicate request detection. This endpoint currently accepts keys up to 128 characters. Alpaca is moving toward a 36-character maximum; new implementations should generate a unique UUIDv7 or UUIDv4 value (36 characters including hyphens) for each logical operation. Do not reuse a key across operations. (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 Successfully requested minting of a tokenized asset. - 400 Bad request (e.g. malformed input, insufficient position, or account not authorized to mint). Also returned when the `Idempotency-Key` header is malformed, or when replaying a request that was originally rejected. - 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, or the same `Idempotency-Key` was reused with a different request body. -
-