API Reference
OPIE Documentation
Getting started
Overview: How to work with OPIE
Get your API key
Anatomy of an OPIE call
Make a test OPIE call
Integrate OPIE into your code
Using OPIE
Make a web app to search and view satellite images
How to work with OPIE
Ty Rayner
published on 2022-12-28
published on 2022-12-28
So you want to give OPIE a try? We’re glad you’re here. Now let’s get right to it!
Quick start: up and running in 4 steps
- First, Sign up for your free OPIE trial account. At the end of this one-page signup, you will receive your API key. This API key is a short string of characters that you’ll pass along with every API call.
- Once you have your API key, start by sending a simple ping to the OPIE API.
You can do this in any programming language or environment, so long as you can
manage and send HTTPS requests.
curl 'https://api.opie.earth/opie/pingauth' -H 'opie-key: [YOUR API KEY]'
- View the API reference. It’s convenient to keep this page open while working with OPIE. Fun fact: You can even run API calls directly from the API reference.
- Build! Design, develop, iterate, and amaze. Check out the examples under ”Using OPIE” at the left of this page. And please do contact us if there’s any way we can help make OPIE the perfect Earth data source for your project.