Get Trading Period List
Returns a paginated list of trading periods for the partner's financial institution.
Parameters
- params
- Filter and pagination query parameters.
- api_key
- Resolved Partner API key, providing the financial institution scope for the lookup.
Returns
Paginated trading-period list with items and pagination metadata.
Authorization
APIKeyHeader x-api-key<token>
In: header
Query Parameters
status?|
Filter to trading periods in this settlement state (open, pending, or fully_settled).
start_time?|
Lower bound (inclusive) on the period's start_time, UTC. Defaults to the last 90 days when omitted; pass an earlier start_time to reach older periods.
end_time?|
Upper bound (inclusive) on the period's start_time, UTC.
per_page?Per Page
Maximum number of trading periods to return per page.
Default
25Range
1 <= value <= 100last_record_number?Last Record Number
Cursor returned from a previous response; pass to fetch the next page.
Default
0Range
0 <= valuesort_order?PartnerListSortOrder
Sort order on start_time. Defaults to descending (most recent first).
Default
"desc"Value in
"asc" | "desc"Response Body
application/json
application/json
curl -X GET "https://partner-api.investifi.com/v1/trading-periods/"{
"total_records": 0,
"last_record_number": 0,
"per_page": 0,
"items": [
{
"trading_period_id": "string",
"start_time": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"status": "open",
"total_transaction_volume": "string",
"total_transaction_fees": "string"
}
]
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string",
"input": null,
"ctx": {}
}
]
}