Sign Up

Lists API

The Lists API allows you to manage collections of symbols. You can create lists and add requests using different query types: website URLs, company names, or symbol tickers. The system will automatically process these queries to find the corresponding symbols.

Authentication

All requests must include an API token in the X-API-Key header. You can find your API token in your account settings.

Query Types

When creating lists or adding requests, you can use different types of queries:

  • Website URLs (e.g., "apple.com", "google.com")
  • Company names (e.g., "McDonalds", "Tesla Inc")
  • Symbol tickers (e.g., "AAPL", "GOOGL")
The system will automatically process these queries to find the corresponding symbols.

Request Processing

When you submit a request:

  • The request is initially created with a 'pending' status
  • The system processes the query to find the corresponding symbol
  • Once processed, the symbol is added to the list
  • You can check the status of requests using the Get List Requests endpoint

Rate Limits

API calls are limited to 100 requests per minute per API token. If you exceed this limit, you'll receive a 429 Too Many Requests response.