Responses & pagination
Successful responses
Section titled “Successful responses”Every successful data call returns:
type FiskResult<T> = { data: T; meta: { asOf?: string; nextOffset?: number | null; hasMore?: boolean; quota?: { limit: number; remaining: number }; sourceNotes?: string; status?: string; };};data can be a list, an object or null, depending on the endpoint and available data.
| Metadata | Meaning |
|---|---|
asOf |
When the gateway assembled this result; not a market quote timestamp |
nextOffset |
Next allowed offset, or null |
hasMore |
More matching rows exist beyond the returned page |
quota.limit |
Account’s daily connector allowance |
quota.remaining |
Remaining daily connector calls after this request |
sourceNotes |
Context to preserve with the data |
status |
Additional status when supplied, such as an unavailable quote |
Pagination
Section titled “Pagination”Documents, financial facts and events accept limit and offset.
limit: 1–20, default 10.offset: 0–100, default 0.- Use the returned
nextOffset; stop when it isnull.
hasMore can be true while nextOffset is null when the pilot’s accessible window ends. It is not a signal to bypass the offset cap.
Company search has a bounded result list without pagination. Document keyword search has at most five excerpts and no pagination.
Missing and empty results
Section titled “Missing and empty results”| Response | Interpretation |
|---|---|
data: [] |
No matching rows are available |
data: null for a quote |
No quote is available |
A null object field |
The field is unknown or unavailable |
404 NOT_FOUND |
The requested published resource was not found |
None of these states means a monetary value is zero.
Request references
Section titled “Request references”The X-Request-Id response header identifies a request. Errors also include error.requestId in their JSON envelope. Include this reference when contacting Fisk; omit tokens and private account information.
Responses use Cache-Control: no-store. Any downstream data storage, caching or redistribution should follow the terms agreed for your business integration.