Sign in

v1

latestOpenAPI 3.0.02026-07-26166415635.8 KB
Accounts

Request options trading for an account (BETA)

This endpoint requests options trading for an account. Following submission, an assigned administrator will review the request. Upon approval, the account's options_approved_level parameter will be modified, granting the account the ability to participate in options trading. Note: This endpoint is only available for partners who have been enabled for Options BETA.

post/v1/accounts/{account_id}/options/approval

Path parameters

account_idstring uuid required

Account identifier.

Request body

level1 | 2 | 3

The desired option trading level. 1=Covered Call/Cash-Secured Put, 2=Long Call/Put, 3=Spreads/Straddles.

Example request

{
  "level": 3
}

Response

The request was submitted successfully.

account_idstring uuid

The account ID.

approved_level0 | 1 | 2 | 3

The option trading level approved for this request. Only present once the request has completed processiing. Note that a subsequent request may be approved for a different level. 0=Disabled, 1=Covered Call/Cash-Secured Put, 2=Long Call/Put, 3=Spreads/Straddles."

created_atstring date-time

The time when the request was submitted.

idstring uuid

The request ID.

requested_level0 | 1 | 2 | 3

The request option trading level. 0=Disabled, 1=Covered Call/Cash-Secured Put, 2=Long Call/Put, 3=Spreads/Straddles.

requester'CORRESPONDENT' | 'ALPACA_ADMIN'

The requester of the options approval request.

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.
updated_atstring date-time

The time when the request was last updated.

Example response

{
  "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"
}