Get Trading Period List
Requires the read:user scope.
Returns a paginated list of trading periods for the partner's financial institution.
Paginated trading-period list with items and pagination metadata.
Authorization
APIKeyHeader Partner API key, required on every endpoint except "GET /health". Your financial institution issues and revokes these keys from the InvestiFi Ops Center. Each key carries an environment-identifying prefix such as "ifi_prod_" plus a fixed set of scopes, so a valid key still returns 403 Forbidden on an endpoint whose scope it was not granted; the response "detail" names the check that failed.
In: header
Query Parameters
Filter to trading periods in this settlement state (open, pending, or fully_settled).
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.
Upper bound (inclusive) on the period's start_time, UTC.
Maximum number of trading periods to return per page.
251 <= value <= 100Cursor returned from a previous response; pass to fetch the next page.
00 <= valueSort order on start_time. Defaults to descending (most recent first).
"desc""asc" | "desc"Response Body
application/json
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": "Key does not have the required scope: read:user."
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string",
"input": null,
"ctx": {}
}
]
}