Sign Up

    Lists API

    Back to API Documentation

    Lists API Documentation

    Manage collections of symbols, create custom lists and monitor multiple assets easily

    Authentication Required

    Please sign in or create an account to use the API. The basic API is free to use for everyone.

    Sign In

    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

    You can authenticate your API requests in two ways:

    1. Using HTTP Headers

    Include your API token in the request header:

    X-API-Key: your_api_token

    2. Using Query Parameters

    Alternatively, you can pass your API token as a query parameter:

    https://api.example.com/v1/u/lists?api_token=your_api_token

    Note: Using the header method is recommended for production environments as it's more secure than exposing your token in URLs.

    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.

    API Reference

    Explore the Lists API endpoints to create and manage collections of symbols