Skip to main content
POST
/
contracts
Create Contract
curl --request POST \
  --url https://v1.api.flux-os.com/contracts \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-user-id: <api-key>' \
  --data '
{
  "external_id": "<string>",
  "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>",
  "end_date": "2023-12-25",
  "differential_unit_amount": null,
  "differential_currency": null,
  "differential_measurement_unit": null,
  "percentage_of_index": null,
  "percentage_of_index_measurement_unit": null,
  "percentage_of_benchmark": null,
  "percentage_of_benchmark_measurement_unit": null,
  "eq": null,
  "index": null,
  "product_category": null,
  "stream": null,
  "benchmark": null,
  "stream_wadf": null,
  "feeder_wadf": null,
  "broker_transaction_id": null
}
'
{}

Authorizations

x-api-key
string
header
required
x-user-id
string
header
required

Body

application/json
external_id
string
required
Maximum string length: 255
term
any
required
transaction_type
any
required
type
any
required
start_date
string<date>
required
volume
number
required
volume_measurement_unit
any
required
measurement_type
any
required
pricing_basis
any
required
settlement_currency
any
required
payment_term
any
required
end_date
string<date>
differential_unit_amount
number | null
differential_currency
unknown
differential_measurement_unit
unknown
percentage_of_index
number | null
percentage_of_index_measurement_unit
unknown
percentage_of_benchmark
number | 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
string | null
Maximum string length: 255

Response

Contract successfully created.

data
object