Retrieve JIT Reports

get

https://broker-api.sandbox.alpaca.markets/v1/transfers/jit/reports

Retrieves a JIT report for the requested report type and system date. By default, the report is returned inline. For large reports, use response_type=download_url to receive a temporary signed download URL.

Generated SDKs return the JSON response. To retrieve a report through an SDK, set response_type=download_url and download the file from url.

Query Params

report_type

string

enum

required

The type of report you want to get.

Show Details

balance	CSV snapshot of settled and unsettled cash by account and currency for the report date.
detail	CSV transaction details with explicit settlement dates and legacy T+N category labels.
detail_v2	CSV transaction details with settlement dates, execution timestamps, and entry subtypes.
gross_payment	Gross payment invoice in PDF using the legacy T+N presentation.
gross_payment_final	Final gross payment invoice in PDF using the legacy T+N presentation.
gross_summary	CSV gross totals by currency in T+0/T+1/T+2 buckets.
gross_summary_v2	CSV gross totals by explicit settlement date and currency, with no T+N columns.
net_payment	Net payment invoice in PDF using the legacy T+N presentation.
net_payment_final	Final net payment invoice in PDF using the legacy T+N presentation.
net_summary	CSV signed totals by currency in T+0/T+1/T+2 buckets. Crypto uses T+0 only.
net_summary_v2	CSV signed totals by explicit settlement date and currency, with no T+N columns.
obligation	CSV individual settlement Obligations, including earlier Obligations that remain open.
obligation_v2	CSV Obligations grouped by account, settlement date, currency, and direction across report dates.
payment	Legacy alias for gross_payment.
settlement	CSV open settlement records with explicit settlement dates and external references.
summary	Legacy alias for gross_summary.

system_date

date

required

Date of file generation.

asset_class

string

enum

The asset class to retrieve for.

Allowed:

response_type

string

enum

Defaults to inline

Controls how the report is returned. Use inline to return the report content directly in the response. Use download_url to return a temporary signed URL that can be used to download the generated report. If omitted, the default value is inline.

Allowed:

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Response

Language

Credentials

Basic

base64

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/pdf

text/csv

200The report file when response_type is inline or omitted, or a temporary download link when response_type is download_url.