ALalpacahq
Funding

Retrieve 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.

get/v1/transfers/jit/reports

Request

  • Base URL
    https://broker-api.giftcity.sandbox.in.alpaca.markets
  • URL
    https://broker-api.giftcity.sandbox.in.alpaca.markets/v1/transfers/jit/reports
  • Auth
    HTTP basic

Query parameters

report_type'detail' | 'detail_v2' | 'net_summary' | 'net_summary_v2' | 'net_payment' | 'net_payment_final' | 'gross_summary' | 'gross_summary_v2' | 'gross_payment' | 'gross_payment_final' | 'obligation' | 'obligation_v2' | 'settlement' | 'balance' | 'summary' | 'payment' required

Report file to retrieve. Availability depends on the correspondent's JIT configuration. The _v2 suffix identifies a file format, not JIT generation v2.

Example:gross_summary_v2

The type of report you want to get.

system_datestring date required

Date of file generation.

asset_class'us_equity' | 'crypto'

The asset class to retrieve for.

response_type'inline' | 'download_url'

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.

Response

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

expires_atstring date-time required

Timestamp when the signed URL expires.

filenamestring required

Name of the generated report file.

urlstring uri required

Temporary signed URL used to download the report.

Changes

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