curl --request GET \
--url https://v1.api.flux-os.com/contracts \
--header 'x-api-key: <api-key>' \
--header 'x-user-id: <api-key>'{
"data": [
{
"external_id": "<string>",
"organization": "<unknown>",
"term": "<unknown>",
"transaction_type": "<unknown>",
"type": "<unknown>",
"start_date": "2023-12-25",
"volume": 123,
"volume_measurement_unit": "<unknown>",
"measurement_type": "<unknown>",
"pricing_basis": "<unknown>",
"settlement_currency": "<unknown>",
"payment_term": "<unknown>",
"id": "<string>",
"status": "<unknown>",
"end_date": null,
"differential_unit_amount": null,
"differential_currency": "<unknown>",
"differential_measurement_unit": "<unknown>",
"percentage_of_index": null,
"percentage_of_index_measurement_unit": "<unknown>",
"percentage_of_benchmark": null,
"percentage_of_benchmark_measurement_unit": "<unknown>",
"eq": "<unknown>",
"index": "<unknown>",
"product_category": "<unknown>",
"stream": "<unknown>",
"benchmark": "<unknown>",
"stream_wadf": "<unknown>",
"feeder_wadf": "<unknown>",
"broker_transaction_id": null,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"meta": {
"current_page": 123,
"total_pages": 123,
"total_items": 123,
"per_page": 123
}
}Retrieve a list of contracts with pagination and filtering options.
curl --request GET \
--url https://v1.api.flux-os.com/contracts \
--header 'x-api-key: <api-key>' \
--header 'x-user-id: <api-key>'{
"data": [
{
"external_id": "<string>",
"organization": "<unknown>",
"term": "<unknown>",
"transaction_type": "<unknown>",
"type": "<unknown>",
"start_date": "2023-12-25",
"volume": 123,
"volume_measurement_unit": "<unknown>",
"measurement_type": "<unknown>",
"pricing_basis": "<unknown>",
"settlement_currency": "<unknown>",
"payment_term": "<unknown>",
"id": "<string>",
"status": "<unknown>",
"end_date": null,
"differential_unit_amount": null,
"differential_currency": "<unknown>",
"differential_measurement_unit": "<unknown>",
"percentage_of_index": null,
"percentage_of_index_measurement_unit": "<unknown>",
"percentage_of_benchmark": null,
"percentage_of_benchmark_measurement_unit": "<unknown>",
"eq": "<unknown>",
"index": "<unknown>",
"product_category": "<unknown>",
"stream": "<unknown>",
"benchmark": "<unknown>",
"stream_wadf": "<unknown>",
"feeder_wadf": "<unknown>",
"broker_transaction_id": null,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"meta": {
"current_page": 123,
"total_pages": 123,
"total_items": 123,
"per_page": 123
}
}Page number for pagination
x >= 1Filter by external ID
Filter by contract term ID
Filter by contract transaction type ID
Filter by production month in format YYYY-MM-DD
Field to sort by
id, term, type, transaction_type, external_id, start_date, end_date, created_at, updated_at Sort direction (asc or desc)
asc, desc A paginated list of contracts.
Show child attributes
255255