n2yo-api-wrapper 0.0.2

Unofficial Wrapper for N2YO.com API

🛰️ N2YO.com Python API Wrapper

A lightweight, feature-complete Python interface for satellite tracking using N2YO.com's API

🛰️ About The Project

A Pythonic interface for accessing real-time satellite data from N2YO.com. This wrapper simplifies interactions with the N2YO API by handling authentication, request formatting, error handling, and response parsing - transforming JSON payloads into native Python objects.

✨ Key Features

• Real-time Satellite Tracking: Get current position and trajectory data
• Pass Prediction: Calculate visible passes for any location
• TLE Data Access: Retrieve latest orbital parameters
• Satellite Search: Find satellites by name/category
• Type Annotations: Full IDE support and type safety

⚙️ Installation

pip install n2yo-api-wrapper

🔑 API Key Setup

1. Get a free API key from N2YO.com
2. Setup client

from n2yo import n2yo
client = n2yo(api_key="YOUR_API_KEY")'

🚀 Usage Examples

from n2yo import n2yo

# Initialize client
client = n2yo(api_key="YOUR_API_KEY")

# Get satellite positions
positions = client.get_satellite_positions(25544, 41.702, -76.014, 500, 10)

# Predict visible passes
passes = client.get_visual_passes(25544, 41.702, -76.014, 500, 3)

# Retrieve TLE data
tle = client.get_tle(25544)

# Return all objects within a given search radius above observer's location
above = client.get_above(41.702, -76.014, 0, 70, 18)

📜 Error Handling

• N2YOInvalidKeyException: Invalid API key.

try:
    data = client.get_positions(...)
except N2YOInvalidKeyException:
    print("Invalid API key configured")

📚 Full Method Reference

Please refer to the full documentation

📃 License

This project is licensed under the MIT License.

👨‍💻 Our Contributors