The API Portal provides programmatic access to ForecastWatch data. Use the API to integrate forecast accuracy data into your own applications, dashboards, or automated workflows.
[IMAGE: api-portal-overview.png]
API Key Management
Your API access is controlled by API keys. In the API Portal, you can:
- View your API key: Copy your key for use in applications
- Regenerate keys: Create a new key if your current one is compromised
- View key status: See if your key is active and when it was last used
[IMAGE: api-key-management.png]
Endpoint Documentation
The portal includes comprehensive documentation for all available API endpoints:
- Endpoint URL: The full URL path for each endpoint
- HTTP method: GET, POST, etc.
- Parameters: Required and optional query parameters with descriptions
- Response format: JSON schema showing the structure of returned data
- Example responses: Sample JSON payloads
API Playground
The built-in playground lets you test API calls directly in your browser:
- Select an endpoint from the documentation
- Fill in the required parameters
- Click Send to execute the request
- View the response data and HTTP status code
This is useful for exploring the API before writing integration code.
[IMAGE: api-playground.png]
Usage Monitoring
Track your API usage in real time:
- Request count: Total API calls made in the current billing period
- Rate limits: Your current rate limit and remaining quota
- Usage chart: Visual breakdown of API calls over time
Integration Tips
- Use the playground to prototype queries before coding your integration
- Cache API responses to minimize unnecessary requests
- Include proper error handling for rate-limited responses (HTTP 429)