# API Reference

## Account Endpoints

Information retrieval for your account.  

{% content-ref url="api-reference/account" %}
[account](https://openet.gitbook.io/docs/reference/api-reference/account)
{% endcontent-ref %}

## Raster Endpoints

Custom data services. More computationally intensive, but more options available.    

{% content-ref url="api-reference/raster" %}
[raster](https://openet.gitbook.io/docs/reference/api-reference/raster)
{% endcontent-ref %}

## Geodatabase Endpoints

Pre-computed data services. Faster to retrieve, but geometries are fixed. 

{% content-ref url="api-reference/geodatabase" %}
[geodatabase](https://openet.gitbook.io/docs/reference/api-reference/geodatabase)
{% endcontent-ref %}

## High-level Comparison

{% tabs %}
{% tab title="Geodatabase" %}

* [x] Lighting fast queries
* [x] Single request multi-model, multi-variable data retrieval supported 
* [x] OpenET field boundary geometry retrieval as geoJSON 
  {% endtab %}

{% tab title="Raster" %}

* [x] Retrieve daily data
* [x] Gridded raster retrieval as GeoTIFF
* [x] Large query support with data exporting
* [x] Additional query customization
* [x] Dynamic map generation with automated tile cache 
* [x] Account syncing with Earth Engine 
  {% endtab %}
  {% endtabs %}

## Accepted Parameters

Here are the current API parameter names and input values. If you aren't sure about the datatype, check out the endpoint schemas or one of the provided examples. Optional parameters are not checked with their default in **bold**. 

{% hint style="success" %}
**Note**: capitalization is optional for parameter values, unless it is a predefined user value such as a shapefile attribute name. 
{% endhint %}

{% tabs %}
{% tab title="Account" %}

* [x] **file**: Multipart form data path as a string.
  {% endtab %}

{% tab title="Geodatabase" %}

* [x] **date\_range**: Inclusive start and end dates in an ISO8061 format as a list.
* [x] **interval**: Data time step. Currently only  *`monthly`*, supported. 
* [x] **geometry**: A longitude, latitude coordinate list for a simple closed polygon.
* [x] **model**: OpenET model. Choose from *`Ensemble`*, *`geeSEBAL`*, *`SSEBop`*, *`SIMS`*, *`DisALEXI`*, *`PTJPL`*, or *`eeMETRIC`.* 
* [x] **field\_ids**: A list of unique OpenET field identifiers. 
* [x] **variable**: Collection variable. Choose from *`ET`*, *`ET_MAD_MIN`*, *`ET_MAD_MAX`*, *`ETo`*, *`ETof`*, *`NDVI`*, or *`PR`*. 
* [ ] **version**: Asset collection version. Choose from `2.0` and **`2.1`**.
  {% endtab %}

{% tab title="Raster" %}

* [x] **asset\_id**: Path to Google Earth Engine feature collection. Must be shared with *`openet@googlegroups.com`*. 
* [x] **attributes**: List of shapefile attributes to include in extraction. Must include a unique identifier for each polygon. 
* [ ] **cog**: Boolean for cloud optimized GeoTIFF format. Default is ***`False`***. 
* [x] **date\_range**: Inclusive start and end dates in an ISO8061 format as a list.
* [ ] **drive\_folder**: If Earth Engine account is linked you may specify the destination folder you have created at the root of your Google Drive. Default is ***`OpenET Exports`***. 
* [ ] **encrypt**: Boolean for file export encryption if enable for your account. Default is ***`False`***. 
* [x] **file\_format**: Output file extension. Choose from *`csv`* or *`json`*. 
* [x] **geometry**: A longitude, latitude coordinate list for a simple closed polygon.
* [x] **gradient**: Visual options containing min and max bounds with list of hex codes for a color ramp. 
* [x] **interval**: Data time step. Choose from *`daily`*, or *`monthly`*. 
* [x] **model**: OpenET model. Choose from *`Ensemble`*, *`geeSEBAL`*, *`SSEBop`*, *`SIMS`*, *`DisALEXI`*, *`PTJPL`*, or *`eeMETRIC`.* 
* [ ] **overpass**: When interval is set to daily, returns only the satellite observed scenes. Default is ***`False`***. 
* [x] **reducer**: Pixel aggregation method. Choose from *`min`*, *`max`*, *`mean`*, *`median`*, *`mode`*, or *`sum`*. 
* [x] **reference\_et**: Source collection for ET reference. Choose from *`CIMIS`* (California only) or *`gridMET`*. NOAA's forecasted reference ET `FRET` can now be used for 7 day forecasts. 
* [ ] **resample**: Pixel re-sampling in meters for raster data. Choose from ***`0`***, *`10`*, *`20`*, or *`30`*.  
* [x] **tracking\_id**: Alphanumeric id assigned after exporting data. 
* [ ] **units**: Output unit for depth measurement. Choose from *`in`* or ***`mm`***. 
* [x] **variable**: Collection variable. Choose from *`ET`*, *`ET_MAD_MIN`*, *`ET_MAD_MAX`*, *`ETo`*, *`ETr`*, *`ETof`*, *`NDVI`*, *`PR`*, `COUNT`, or `MODEL_COUNT` 
* [ ] **version**: Asset collection version. Choose from `2.0` or **`2.1`**.
  {% endtab %}
  {% endtabs %}