To use any Planet API, you'll need an API key. API keys are available to all registered users with active Planet accounts.
Find your API Key
Once you're signed up, log in to your account at planet.com/account to get your API key. Find the API key field under your account information, as seen here:
Planet's API Ecosystem
Planet's platform is made up of a collection of APIs. These include:
- Data API - allows you to search Planet's complete catalog of data
- Analytics API - give you access to derived analytic products like Planet Analytic Feeds
- Tile Services - XYZ and WMTS tile map services for use in your favorite GIS or mapping client
- Orders API - raster tools for creating analysis-ready data with Planet's imagery archive
- Tasking API - API for creating and managing your SkySat point collection orders
You can read more about each API and find complete docs and API reference guides here.
Quickstart: Search & Download Imagery
If you're new to Planet's APIs and just want to search for and download an image, then start with the Data API.
A Python-based Jupyter Notebook is available here if you'd like to interactively try out searching & downloading with the Data API (recommended).
Otherwise, if you prefer to do it from scratch, keep reading for a step-by-step walk through of the entire process.
Conducting an image search
Searching for imagery in an Area of Interest while specifying our desired Item and Asset types
- Define an Area of Interest (AOI) and save it as a GeoJSON file
- Create search filters to specify the type of data you want to see
- Use the Data API to conduct a 'quick search' of the Planet catalog
- Extract the item ID of the image you would like to download from the quick search response body
- Use that Item ID to list available assets for this item (more details on Items & Assets can be found in the docs)
Activating & downloading the image
The Data API does not pre-generate assets, so they are not always immediately availiable to download. In order to download an asset, we first have to activate it. Once an asset has been activated, a temporary download link will become available.
- Call the
"activate"link for your desired asset to begin the activation process
- Poll the
"_self"link for the asset to check the
statusvalue: an asset will change from
activewhen it's ready for download.
- The payload of the
"_self"link you used above will now include a
locationvalue: make a GET request against that URL to begin downloading the image