List reports

get/api/v2/reports

Lists generated reports.

Query Parameters

  • limitintegerDefault: 25
    Number of reports to return
  • createdAtGtstring
    Only return reports created after this date
  • enterprisestring
    Only return reports for this enterprise
  • walletstring
    Only return reports for this wallet
  • walletTypestring
    Only return reports for this wallet type
  • reportTypestring
    Only return reports for this report type
    Enum: holdings transactions trades
  • statusstring
    Only return reports for this report status
    Enum: pending processing completed failed
  • prevIdstring
    Only return reports created after this id
  • formatstring
    Only return reports for this report format
    Enum: csv pdf
  • assetstring
    Only return reports for this report asset
  • holdings.byWalletboolean
    Filter holdings reports by wallet
  • transactions.isDetailedboolean
    Filter transfer details report
  • trades.isFillsReportboolean
    Filter trades fills report

200 Response

reports array[Holdings]
id string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
type string
Type of report
Allowed values: holdings transactions trades
format string
Format of report
Allowed values: pdf csv
status string
Status of report
Allowed values: pending processing completed failed
createdAt string <date-time>
Date report was created
completedAt string <date-time>
Date report was completed
documentName string
Name of the report document
user string
ID of the user who requested the report
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
holdings object
nextBatchPrevId string
The prevId to use for the next batch of reports

400 Response

allOf All of
object
error string required
Human-readable error message
requestId string required
Client request id
object
context object
Properties that apply to a specific error name
name string required
Error code