API Documentation
Introduction - API Reference
The Finvera API enables developers to retrieve various financial datasets that power firms from fintech startups, to enterprise brokerage applications. Below are the key concepts to understand before integrating.
To create your free trial API key, you can head over to the API Key Management Dashbord.
Authentication
All API endpoints are authenticated using query parameter authentication. Once you have copied the key from the dashboard, you can authenticate the endpoint.
For example:
Rate Limits
To ensure fair usage and system stability, we enforce rate limits:
- Standard Tier: 60 requests per minute
- Enterprise Tier: Custom rate limits available
If you exceed your rate limit, you will receive a
429 Too Many Requestsresponse. Consider implementing exponential backoff when retrying requests.
Query Parameters
To optimize data retrieval, the API supports query parameters for filtering and pagination.
Common Query Parameters:
limit: Number of results per request (default: 50, max: 500)offset: Pagination offset for large result setssort: Sort results by a specific field (ascordesc)date_range: Filter results within a specific date range (YYYY-MM-DDformat)symbol: Retrieve data for a specific stock ticker
Best Practices for API Performance
- Use Pagination: Avoid retrieving large datasets in a single request.
- Cache Responses: Use Redis or other caching mechanisms to store frequent queries.
- Optimize Queries: Filter data at the API level to reduce response payloads.
- Batch Requests: When possible, use batch endpoints instead of multiple single calls.
- Monitor Usage: Use AltData’s API analytics to track usage and optimize accordingly.
For further details, explore each API section with code examples and integration tips.