Account

Information about your OpenET account.

Note: OpenET uses a tiered system for accounts. Results from each of the following endpoints may vary by account. For more information, check out the Quota section.

Account Status

Retrieve information about your account in a JSON format. See the Quota page for additional details.

post

Upload a temporary GeoJSON file to use with OpenET.

Authorizations

Body

filestring · binaryrequired

Responses

application/json

application/json

200

422

200

No body

Successful Response

Take a look at how you might call this method:

curl

curl -X 'GET' \
  'https://openet-api.org/account/status' \
  -H 'accept: application/json' \
  -H 'Authorization: YOUR_API_KEY' 

Python

import requests

# set your API key before making the request
header = {"Authorization": YOUR_API_KEY}

# query the api 
resp = requests.get(
    headers=header,
    url="https://openet-api.org/account/status"
)

print(resp.json())

Account Storage

If your OpenET account is not synced with your personal Google Earth Engine account, all exported data will be stored in a secure private Google Cloud Bucket. The following endpoint allows you to retrieve downloadable links to these files. This endpoint must be called to continue exporting if there are over 100 files which have not been retrieved.

Once this endpoint has been called, all existing files will be moved to a public bucket with a 24 hour lifecycle. Data return is in a JSON format.

Warning: exported files will be automatically deleted after 7 days if not retrieved.

get

Retrieves information on all current files exported to OpenET's Google Bucket.

Authorizations

Responses

application/json

200

200

No body

Successful Response

Take a look at how you might call this method using our official libraries, or via curl:

curl

curl -X 'GET' \
  'https://openet-api.org/account/storage' \
  -H 'accept: application/json' \
  -H 'Authorization: YOUR_API_KEY' 

Python

import requests

# set your API key before making the request
header = {"Authorization": YOUR_API_KEY}

# query the api 
resp = requests.get(
    headers=header,
    url="https://openet-api.org/account/storage"
)

print(resp.json())

Upload a File

As an alternative to storing shapefiles on Google Earth Engine, OpenET allows you to generate a temporary asset id by uploading a RFC 7946 formatted GeoJSON file to delineate boundaries for data extractions.

Each file uploaded has a maximum file size of 25mb and expires after 72 hours. During this time you can use the generated temporary asset id for the corresponding parameter. Data return is in a JSON format.

post

Upload a temporary GeoJSON file to use with OpenET.

Authorizations

Body

filestring · binaryrequired

Responses

application/json

application/json

200

422

200

No body

Successful Response

Take a look at how you might call this method using python, or via curl:

curl

curl -X 'POST' \
  'https://openet-api.org/account/upload' \
  -H 'accept: application/json' \
  -H 'Authorization: YOUR_API_KEY' \
  -H 'Content-Type: multipart/form-data' \
  -F 'file=@YOUR_FILE.geojson'

Python

import requests

# set your API key before making the request
header = {"Authorization": YOUR_API_KEY}

# endpoint arguments
args = {
    'file': ('PATH/TO/sample.geojson', open('PATH/TO/sample.geojson', 'rb'), 'application/geo+json')
}

# query the api 
resp = requests.post(
    headers=header,
    files=args,
    url="https://openet-api.org/account/upload"
)

print(resp.json())

Decrypt a File

If you have opted to encrypt a file during an export, the following endpoint allows you to decrypt it. This works for both .TIFF rasters and .CSV files. Each account has its own unique rotating key so that no user will be able to decrypt another user's files.

Note: OpenET's free account tier does not offer this encryption service. See the Quota page for more information.

post

Decrypt an OpenET encrypted file.

Authorizations

Body

filestring · binaryrequired

Responses

application/json

application/json

200

422

200

No body

Successful Response

Take a look at how you might call this method using our official libraries, or via curl:

curl

curl -X 'POST' \
  'https://openet-api.org/account/decrypt' \
  -H 'accept: application/json' \
  -H 'Authorization: YOUR_API_KEY' \
  -H 'Content-Type: multipart/form-data' \
  -F 'file=@YOUR_ENCRYPTED_FILE.tif;type=image/tiff'

Python

import requests

# set your API key before making the request
header = {"Authorization": YOUR_API_KEY}

# endpoint arguments
args = {
    'file': ('PATH/TO/encrypted.geojson', open('PATH/TO/encrypted.geojson', 'rb'), 'application/geo+json')
}

# query the api 
resp = requests.get(
    headers=header,
    files=args,
    url="https://openet-api.org/account/decrypt"
)

print(resp.json())