API Reference

/delineated-fields

get
https://api.digifarm.io/v1/delineated-fields

Returns GeoJSON of delineated fields in the given bbox, up to limit fields (default 1000). If you get limit fields, split the bbox to get the rest.

Fields this token hasn't received before are charged when they are served; fields it has already paid for are free. estimate=true returns the cost instead of the fields, and credits_charged in the response is what the request was charged.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Client Token provided by Digifarm

string

Bounding box string in format minLongitude,minLatitude,maxLongitude,maxLatitude

string

The billing option for the request - either by the number of fields('by_field') or the area of the bbox('by_haa') queried

string

Version of the data served. Currently only supports 'latest'

number

The maximum number of fields returned. Default 1000

boolean

When true, returns what this request would cost (CreditEstimate) instead of the fields. Nothing is charged or reserved

boolean

When true and your balance doesn't cover the new fields (or your credits have expired), returns only the fields you have already paid for, with a credits_warning, instead of a 402

Responses

400

The bbox is invalid, or the response would be too large to return (over about 6 MB): narrow the bbox or use a lower limit. Nothing is charged. estimate=true doesn't check the size

403

API token invalid

Updated about 6 hours ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 6 hours ago