Appearance
Intraday Breakevens
The Intraday Breakevens endpoints allow you to pull Spark's Intraday Arb Breakevens curves. These prices can be pulled live every 10 minutes, or the entire historical dataset can be downloaded for historical analysis. Intraday data is published between 7am & 5pm UKT.
Looking to pull Intraday data?
Visit our Python Code Examples section to download our Intraday code samples, the quickest way to start pulling Intraday data.
Intraday API Subscription Required
Contact us to discuss our Premium plans at commercial@sparkcommodities.com
Reference Data
/beta/intraday/breakevens/reference-data/
The Breakevens Reference Data endpoint returns the UUID codes associated with each FoB Port available on the Breakevens endpoint.
- The FOB port UUID
- The FOB port name
- The Via point of the route (Suez, Panama, etc .)
Live
/beta/intraday/breakevens/live/
Call this endpoint to retrieve the latest published Intraday Breakevens prices.
Parameters
This endpoint has five parameters:
fob-port- Required parameter
- Input the FOB port UUID you would like to retrieve breakevens prices for
unit- Required parameter
usd-per-mmbtuonly- Define what units the retrieved data is in
breakeven-type- Required parameter
- Input the breakeven data you'd like to call
jkm-ttf,jkmorttf
via-point- Optional parameter
- Input the corresponding via point related to your chosen FOB port, if applicable
panamaorcogh
percent-hire- Optional parameter
- Percentage of Freight Hire cost included in the breakevens calculations
- Default is
100, available values are0and100.
Prices can be retrieved in JSON or CSV format, although metadata is only available in the JSON response.
This endpoint will also retrieve any new price revisions - if there are any revisions to report since the last price release, this will be listed within the JSON.
All timestamps are in UK timezone format.
This endpoint is also available on trial.
Historical
/beta/intraday/breakevens/historical/
Call this endpoint to retrieve historical data for our Intraday Breakevens datasets
Parameters
This endpoint has five required parameters:
fob-port- Required parameter
jkm-ttf- Input the FOB port UUID you would like to retrieve breakevens prices for
unit- Required parameter
usd-per-mmbtuonly- Define what units the retrieved data is in
breakeven-type- Required parameter
- Input the breakeven data you'd like to call
jkm-ttf,jkmorttf
start- Required parameter
- Format in
yyyy-mm-dd, oryyy-mm-dd hh:mm:ss - Define what date you'd like the data to begin at. Default timezone format is UKT, but other timezones can be input as long as specified in standard ISO format. This parameter is treated as a datetime object. If you input a
yyyy-mm-dddate format, the endpoint will automatically assume00:00:00as the time.
end- Required parameter
- Format in
yyyy-mm-ddoryyy-mm-dd hh:mm:ss - Define what date you'd like the data to stop at Default timezone format is UKT, but other timezones can be input as long as specified in standard ISO format. This parameter is treated as a datetime object. If you input a
yyyy-mm-dddate format, the endpoint will automatically assume00:00:00as the time.
via-point- Optional parameter
- Input the corresponding via point related to your chosen FOB port, if applicable
panamaorcogh
percent-hire- Optional parameter
- Percentage of Freight Hire cost included in the breakevens calculations
- Default is
100, available values are0and100.
Prices can be retrieved in JSON or CSV format, although metadata is only available in the JSON response.
This endpoint has a max date range of 30 days for each single API pull.
All timestamps are in UK timezone format.
This endpoint is available on trial, but only 2 weeks worth of historical data is available.
Note
If you have any questions regarding our historical data, please contact data@sparkcommodities.com
Revisions
/beta/intraday/breakevens/revisions/
Call this endpoint to retrieve Breakevens price revisions published since the start of the previous business day.
Parameters
This endpoint has two required parameters:
fob-port- Required parameter
jkm-ttf- Input the FOB port UUID you would like to retrieve breakevens prices for
unit- Required parameter
usd-per-mmbtuonly- Define what units the retrieved data is in
breakeven-type- Required parameter
- Input the breakeven data you'd like to call
jkm-ttf,jkmorttf
via-point- Optional parameter
- Input the corresponding via point related to your chosen FOB port, if applicable
panamaorcogh
percent-hire- Optional parameter
- Percentage of Freight Hire cost included in the breakevens calculations
- Default is
100, available values are0and100.
The data is retrieved in JSON and CSV format, although metadata is only available in the JSON response.
This endpoint is also available on trial.