Skip to main content
GET
List spreads

Authorizations

Authorization
string
header
required

API key prefixed with finta_

Query Parameters

limit
integer
default:100

Maximum number of results to return (1-500). Defaults to 100.

Required range: 1 <= x <= 500
starting_after
string

Pass the next_cursor from the previous page, unchanged, with the same filters. Rows in this list have no ID, so the cursor is opaque. A cursor this list didn't produce returns 400 invalid_request.

start_date
string<date>

Only rows whose transaction date is on or after this date, YYYY-MM-DD.

end_date
string<date>

Only rows whose transaction date is on or before this date, YYYY-MM-DD.

transaction_id
string

Only the spreads on this transaction, or on its lines if it is split. An unknown ID returns 404 resource_missing.

Pattern: ^txn_

Response

A paginated list

object
enum<string>
required
Available options:
list
url
string
required
Example:

"/api/v1/spreads"

has_more
boolean
required

Whether there are more results beyond this page.

next_cursor
string | null
required

Pass this value as starting_after to fetch the next page. Null when has_more is false.

data
object[]
required