Skip to main content

Planet Features API (Beta) 

Planet recently released its Features API (Beta). The Features API is a great way to improve the efficiency of your data discovery and delivery workflows by enabling you to store your Areas of Interest (AOIs) once and reference them, as needed, across the platform. Planet discovery and delivery APIs that now support saved Feature references include:

  • Orders API 
  • Subscriptions API 
  • Data API 

The Features API also includes endpoints for validating and simplifying your AOIs so that they meet the Planet geometry rules (such as max 1500 vertex limit) before saving them. After a Feature is saved, it can be accessed as an OGC-compliant Features API.

API docs for the Planet Features API can be found in the Planet Features API documentation

Example Features API workflow 

Note: For more detailed workflow examples, refer the Planet Jupyter Notebook

  1. To create a Feature Collection make a POST to the Collection endpoint and include a Collection name and description. 

POST to https://api.planet.com/features/v0/ogc/my/collections

Q0iQC87_7Vah-kFgf26NoIhB3ZaTNLRMU18vceMcvED27NWbnm7_kCvFEihc7ENOppogUXutxMycpqsxXdty6-BPO9XdvfPSnQdr66J-nt-gjVfLAUl28pipNjywlpucCdYp4FEFWlbXcUFqiKXWDso

  1. To validate that your Features (AOIs) meet the Planet geometry requirements, make a POST request to the /validate endpoint. The API response provides more details if your Feature does not meet the geometry rules. 

POST https://api.planet.com/features/v0/ogc/my/collections/validate

IEqy2fWaGa_WgpL_i7UYTsqvR8fcN8GzdQyxp3Va_GzBpc8rJnJl1SyAXy3iu_XJzdrPdwTlc_RuOvXR5SeHLHeO7i3IaggnINd73kNXnvHKGuE9Jl4ZD45vWfzpnO-8-9Ng8bK5EAIH895rCGRf17k

  1. To add Features (AOIs) to your Feature Collection, make a POST to the items endpoint. You can include Title, ID, and Description properties. 

POST https://api.planet.com/features/v0/ogc/my/collections/:collectionID/items 

4Z-C6N79ManG-IwgU3hctUC-BoClj6rxoQO6VZPLFhPBicvdJ1C0K7yaUf5ATcj6G4MW0s5se_z1q8v4SvSC1bbw-8DH241F7cjrBvTav1Tdgah5rM1DdhRrV2szzJK--Mm83TYix7HOhsx44iL9qec

  1. To share a Feature Collection so that other users in your Organization can find and access the AOI Features, make a POST request to the permission endpoint:

POST https://api.planet.com/features/features/v0/ogc/my/collections/:collectionID/permission 

  1. After a Feature is saved, you can reference it in the Planet delivery APIs. For example, make a POST request to the Orders API to deliver data where you need it. 

POST

https://api.planet.com/compute/ops/orders/v2 

XG0S_SfEv8FMnnRSf41v0flxlAMrmx8bXAyC_r28etwYwTJBuwnx3-VgMyQsAGaeRHOcbv8vCXRBgXbSiL8smsFr6xtM-41JeopuxvX2xHJj7bbBNjKfFEaT62-6-E97j1ldN7u44TgA_-HFMbjkv2g

Feature Reference: A reference (URL, ID) to a specific Feature.

Learning Resources

For information on working with Planet APIs, see Get Started with Planet APIs.

Note: The Planet Features API is currently in Public Beta and future releases may not be backwards compatible. Following the General Availability (GA) release of the API, we will provide support for a duration of six months.

Feedback

Have feedback? Please let us know using the Planet Features API Beta Feedback form.

Be the first to reply!