v1

latestOpenAPI 3.0.02026-07-232731152.8 KB
PortfolioQueryService

GenerateReport generates and streams a report file for download

Uses the reporters registered for report_type/format (see x/portfolio/infra/reporters) — account_id defaults to the caller's own account and requires the :all scope to query on behalf of another

get/portfolio/v1/generate

Query parameters

reportTypestring required

report_type identifies the kind of report to generate (e.g. "trade")

formatstring required

format identifies the output format (e.g. "csv", "pdf")

startDatestring date-time

start_date is the optional inclusive start of the report date range

endDatestring date-time

end_date is the optional inclusive end of the report date range

accountIdstring required

account_id is optional; absent means self-service (from auth context). Providing it requires the reports.generate.read:all scope (admin).

Response

A successful response.

contentTypestring

The HTTP Content-Type header value specifying the content type of the body.

datastring byte

The HTTP request/response body as raw binary.