ALalpacahq
Documents

Retrieve a List of Account Documents

This endpoint allows you to query all the account document based on an account ID. You can filter by date, or type of document.

These account documents are tax statements, trade confirmations, etc, generated by the Alpaca system. They are distinct from the owner documents you upload and later access via the account object's documents property.

get/v1/accounts/{account_id}/documents

Request

  • Base URL
    https://broker-api.giftcity.sandbox.in.alpaca.markets
  • URL
    https://broker-api.giftcity.sandbox.in.alpaca.markets/v1/accounts/{account_id}/documents
  • Auth
    HTTP basic

Query parameters

startstring date

optional date value to filter the list (inclusive).

endstring date

optional date value to filter the list (inclusive).

type'account_application' | 'account_statement' | 'crypto_account_statement' | 'options_application' | 'tax_statement' | 'trade_confirmation_json' | 'trade_confirmation'
Example:account_statement

The type of the account document

Response

OK

datestring date required
idstring uuid required
namestring
sub_typestring

The sub-type of the document. This is a free-form property.

type'account_application' | 'account_statement' | 'crypto_account_statement' | 'options_application' | 'tax_statement' | 'trade_confirmation_json' | 'trade_confirmation' required

The type of the account document

Example response

[
  {
    "date": "2019-09-30",
    "id": "0d18ae51-3c94-4511-b209-101e1666416b",
    "sub_type": "1099-Comp",
    "type": "account_statement"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.