Request action.
Coordinate bounds to search within.
Request endpoint (required).
A comma-delimited list of response properties for the API to return. This parameter is often used to limit the amount of data returned.
Predefined filters for limiting the results. The filter value can be a single, comma-delimited or a semicolon delimited string of filter names.
Either a Date or valid time string from
which to return results for.
Maximum number of results to return.
Location to request data for. Refer to the list of supported place values.
Applied only on the periods response property, the total number of periods to return as
an integer.
Applied only on the periods response property, used to skip over a specific number of
periods in the data set.
Applied only on the periods response property, used to sort results based on certain
fields contained within the periods.
Filters results based on certain fields and values in the dataset. Refer to the advanced queries documentation.
When requesting the closest results within a circle, the radius determines how far from the
specified location to search. A valid unit value must be included in your radius value,
e.g., 5mi, 10km, 25miles. If no unit is provided, your value is assumed to be in
meters by default.
Skips over a specific number of results in the dataset.
Sorts results based on certain fields in the dataset. Refer to the sorting documentation.
Either a Date or valid time string up to
which to return results for. When used in conjunction with from(), this value be relative
to the from value, not relative to the current time.
Generated using TypeDoc
A data type that represents the configuration options for an API data request.