\SettlementApi

Method	HTTP request	Description
SettlementGet	Get /settlement	Get settlement history.

SettlementGet

[]Settlement SettlementGet(ctx, optional) Get settlement history.

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
optional	*SettlementApiSettlementGetOpts	optional parameters	nil if no parameters

Optional parameters are passed through a pointer to a SettlementApiSettlementGetOpts struct

Name	Type	Description	Notes
symbol	optional.String	Instrument symbol. Send a bare series (e.g. XBT) to get data for the nearest expiring contract in that series. You can also send a timeframe, e.g. `XBT:quarterly`. Timeframes are `nearest`, `daily`, `weekly`, `monthly`, `quarterly`, `biquarterly`, and `perpetual`. Symbols are case-insensitive.
filter	optional.String	Generic table filter. Send JSON key/value pairs, such as `{"key": "value"}`. You can key on individual fields, and do more advanced querying on timestamps. See the Timestamp Docs for more details.
columns	optional.String	Array of column names to fetch. If omitted, will return all columns. Note that this method will always return item keys, even when not specified, so you may receive more columns that you expect.
count	optional.Int32	Number of results to fetch. Must be a positive integer.	[default to 100]
start	optional.Int32	Starting point for results.	[default to 0]
reverse	optional.Bool	If true, will sort results newest first.	[default to false]
startTime	optional.Time	Starting date filter for results.
endTime	optional.Time	Ending date filter for results.

No authorization required

Content-Type: application/json, application/x-www-form-urlencoded
Accept: application/json, application/xml, text/xml, application/javascript, text/javascript