Skip to content

Latest commit

 

History

History
49 lines (33 loc) · 2.58 KB

SettlementApi.md

File metadata and controls

49 lines (33 loc) · 2.58 KB

\SettlementApi

All URIs are relative to https://localhost/api/v1

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

SettlementGet

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

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a SettlementGetOpts struct

Name Type Description Notes
symbol optional.String Instrument symbol. Send a bare series (e.g. XBU) to get data for the nearest expiring contract in that series. You can also send a timeframe, e.g. `XBU:monthly`. Timeframes are `daily`, `weekly`, `monthly`, `quarterly`, and `biquarterly`.
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.Float32 Number of results to fetch. [default to 100]
start optional.Float32 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.

Return type

[]Settlement

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]