OpenET API
AccountUser Interface
  • Welcome
  • Quick Start
  • Retrieve API Key
  • Reference
    • API Reference
      • Account
      • Geodatabase
      • Raster
  • Additional Resources
    • Quota
    • Earth Engine
    • Data Availability
    • FARMS
    • Change Log
    • FAQ
    • Tutorial Videos
  • Contact
  • TERMS OF SERVICE
Powered by GitBook
On this page
  1. Reference
  2. API Reference

Account

Information about your OpenET account.

Last updated 11 months ago

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.

Take a look at how you might call this method:

curl -X 'GET' \
  'https://openet-api.org/account/status' \
  -H 'accept: application/json' \
  -H 'Authorization: YOUR_API_KEY' 
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.

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

curl -X 'GET' \
  'https://openet-api.org/account/storage' \
  -H 'accept: application/json' \
  -H 'Authorization: YOUR_API_KEY' 
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

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.

Take a look at how you might call this method using python, or via 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'
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.

Take a look at how you might call this method using our official libraries, or via 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'
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())

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

RFC 7946
post

Upload a temporary GeoJSON file to use with OpenET.

Authorizations
Body
filestring · binaryRequired
Responses
200
Successful Response
application/json
Responseany
422
Validation Error
application/json

No content

get

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

Authorizations
Responses
200
Successful Response
application/json
Responseany
200

Successful Response

No content

post

Upload a temporary GeoJSON file to use with OpenET.

Authorizations
Body
filestring · binaryRequired
Responses
200
Successful Response
application/json
Responseany
422
Validation Error
application/json

No content

post

Decrypt an OpenET encrypted file.

Authorizations
Body
filestring · binaryRequired
Responses
200
Successful Response
application/json
Responseany
422
Validation Error
application/json

No content

  • Account Status
  • POST/account/upload
  • Account Storage
  • GET/account/storage
  • Upload a File
  • POST/account/upload
  • Decrypt a File
  • POST/account/decrypt
Page cover image