v1

latestOpenAPI 3.0.02026-07-26166415635.8 KB

Accounts

Retrieve options level approval requests (BETA)

This endpoint retrieves options trading level approval requests. Query parameters can be specified to filter the results. If multiple query parameters are specified, the results will be filtered to include only those that match all of the specified parameters. Each query parameter can only be specified once.

get/v1/accounts/options/approvals

Query parameters

account_idstring uuid

Example:c8f1ef5d-edc0-4f23-9ee4-378f19cb92a4

Only return results for the specified account.

requested_level0 | 1 | 2 | 3

Only return requests with the specified requested level. 0=Disabled, 1=Covered Call/Cash-Secured Put, 2=Long Call/Put, 3=Spreads/Straddles.

Example:3

approved_level0 | 1 | 2 | 3

Only return requests with the specified approved level. 0=Disabled, 1=Covered Call/Cash-Secured Put, 2=Long Call/Put, 3=Spreads/Straddles.

Example:3

status'PENDING' | 'APPROVED' | 'LOWER_LEVEL_APPROVED' | 'REJECTED'

The request status.

PENDING: The request is under review.
APPROVED: The request has been successfully approved, the account is now able to trade options.
LOWER_LEVEL_APPROVED: The request has been approved for a level lower than the requested one.
REJECTED: The request has been rejected.

Example:PENDING

Only return requests with the specified approval request status.

page_sizeinteger

The maximum number of results to return. The default (and maximum value) is 1000.

page_tokenstring

Example:MA==

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.

Response

The request was submitted successfully.

next_page_tokenstring nullable

Use this token in your next API call to paginate through the dataset and retrieve the next page of results. A null token indicates there are no more data to fetch.

Example response

{
  "next_page_token": "MTAwMA==",
  "options_approvals": [
    {
      "account_id": "c8f1ef5d-edc0-4f23-9ee4-378f19cb92a4",
      "approved_level": 3,
      "created_at": "2021-03-16T18:38:01.942282Z",
      "id": "88b5f678-fef5-447b-af15-f21e367e6d8c",
      "requested_level": 3,
      "requester": "CORRESPONDENT",
      "status": "PENDING",
      "updated_at": "2021-03-16T18:38:01.942282Z"
    }
  ]
}