Open Geodata API Documentationο
π°οΈ Unified Python Client for Satellite Data Access
Open Geodata API provides seamless access to multiple open geospatial data APIs with automatic URL management, intelligent filtering, and maximum flexibility for data reading.
Notebook (API Testing):ο
Here you can access or download the full API References for testing the Open Geodata API:
- NOTE:
This documentation is a work in progress. Contributions are welcome! I appreciate your patience as I continue to improve it. AI helped me a lot to generate this documentation, but it still needs a lot of work to be complete and polished. So maybe all Examples are not tested, and some sections may be incomplete or not fully accurate. If you find any issues, please open an issue on GitHub or contribute directly to the documentation.
π― One Interface
Access Microsoft Planetary Computer & AWS EarthSearch APIs
π Smart URLs
Automatic signing, validation, and expiration handling URLs
π¦ Your Choice
Use any raster package (rioxarray, rasterio, GDAL) to read the data
π Complete Workflow
Search β Filter β Download β Analyze
Quick Startο
# Install the package
pip install open-geodata-api
import open_geodata_api as ogapi
# Create client with auto-signing
pc = ogapi.planetary_computer(auto_sign=True)
# Search for data
results = pc.search(
collections=["sentinel-2-l2a"],
bbox=[-122.5, 47.5, -122.0, 48.0],
datetime="2024-01-01/2024-03-31"
)
# Get ready-to-use URLs
item = results.get_all_items()[0]
blue_url = item.get_asset_url('B02') # Automatically signed!
# Use with ANY raster package
import rioxarray
data = rioxarray.open_rasterio(blue_url)
Documentation Sectionsο
π Getting Started
π‘ Examples & Tutorials
π API Reference
π₯οΈ CLI Reference
β FAQ & Help
- FAQ & Help
- General FAQ
- What is Open Geodata API?
- What satellite data can I access?
- How is this different from using APIs directly?
- What are the costs involved?
- Do I need programming experience?
- Can I use this for commercial projects?
- What about data privacy and security?
- How do I get help and support?
- What are the system requirements?
- Can I contribute to the project?
- Is this production-ready?
- Installation FAQ
- Usage FAQ
- Troubleshooting Guide
- Performance FAQ
- Universal Catalog FAQ
π§ Development
- Development
- Contributing to Open Geodata API
- Architecture and Design
- Testing Guide
- Testing Philosophy
- Test Structure
- Running Tests
- Unit Testing
- Integration Testing
- Performance Testing
- Test Fixtures
- Continuous Integration
- Best Practices
- Advanced Testing Techniques
- Test Data Management
- Test Environment Management
- Debugging Tests
- Test Reporting and Metrics
- Continuous Integration Integration
- Changelog
- License and Legal Information
Philosophyο
Perfect for researchers, data scientists, and developers working with satellite imagery and geospatial analysis.
Community & Supportο
GitHub Repository: open-geodata-api
Issue Tracker: Report Bugs
Documentation: Read the Docs