API reference
Estimates
Estimate a route's distance, flight time and price range. An estimate is not an operator quote.
Estimate a route
POST/v1/estimates
- Scope
read- Quota
- Counts toward your allowance
Request body
legsarray of objectsRequired1 to 10 items.
3 fields in legs
fromstringRequired1 to 12 characters.
tostringRequired1 to 12 characters.
datedate
paxintegerRequiredFrom 1 to 50.
categorystringOne of
pistonturboproplightmidsizesuper_midsizeheavyultra_long_rangehelicopterone_waybooleanDefaults to
true.registrationstring1 to 12 characters.
Response
200 OK
Returns the estimate list object.
Errors
401Unauthorized403Forbidden404Not found422Unprocessable content429Too many requests
Example request
curl --request POST "$CHARTEROPS_API_URL/v1/estimates" \
--header "Authorization: Bearer $CHARTEROPS_API_KEY" \
--json @body.jsonObjects
Estimate list
basisstringitemsarray of objects9 fields in items
basisstringblock_minutesintegercategorystringOne of
pistonturboproplightmidsizesuper_midsizeheavyultra_long_rangehelicoptercurrencystringdistance_nmintegerfees_centsintegerhigh_centsintegerlegsarray of objects4 fields in legs
block_minutesintegerdistance_nmintegerfromobject10 fields in from
citystringCan be nullcodestringcountrystringiatastringCan be nullicaostringCan be nullidUUIDlatitudenumberlongitudenumbernamestringtimezonestringCan be null
toobject10 fields in to
citystringCan be nullcodestringcountrystringiatastringCan be nullicaostringCan be nullidUUIDlatitudenumberlongitudenumbernamestringtimezonestringCan be null
low_centsinteger
tailobjectCan be null6 fields in tail
amount_centsintegerbasisstringblock_minutesintegerhourly_rate_centsintegerorganizationstringregistrationstring