Atlas/API Reference/Symbols

Search symbols

GEThttps://atlas-api.skylit.ai/v1/search

Ranked symbol search for the datafeed's symbol picker (exact ticker > prefix > substring). Returns up to limit matches.

Authorization

Authorization: Bearer <your API key>

Required. A missing header returns 401; an invalid, revoked or expired key returns 403.

Query parameters

  • querystringrequired

    Search text (ticker or name fragment).

  • limitintegerdefault 25min 0 · max 500

    Max results, default 25. A larger value is served as 500 (one call returns at most 500 rows); 0 returns an empty list.

Responses

  • 200

    Matching symbols.

  • 400

    Missing or invalid parameter (invalid_parameter). Refused before metering: never charged, no X-Credits-Remaining.

  • 401

    Missing or invalid API key.

  • 402

    Never charged. One of:

    • insufficient_credits: the balance is below the request cost. Carries X-Credits-Remaining.
    • monthly_cap_reached: the account's monthly spend cap is used up; it resets at the start of next month. Carries X-Credits-Remaining.
    • daily_cap_reached: the plan's daily credit limit is used up; it resets at midnight ET. Refused before metering, so it carries no X-Credits-Remaining; carries Retry-After (seconds to the reset).
  • 403

    Never charged. One of:

    • the gateway's forbidden: an unknown, revoked or expired API key.
    • account_suspended: the account is not API-eligible. Not retryable.
    • account_blocked: API access for this account is blocked; contact support. Refused before metering (no X-Credits-Remaining).
    • not_entitled: the plan does not include this feature or symbol, or the symbol is a futures contract, which the API does not serve. Refused before metering (no X-Credits-Remaining).
  • 429

    Never charged. The gateway's rate_limited (per-minute ceiling; no Retry-After, wait for X-RateLimit-Reset), or the API's too_many_concurrent_requests (too many requests in flight for this account; refused before metering, Retry-After: 1).

  • 503

    Temporarily unavailable; retry. One of api_paused (the API is paused by an operator; refused before metering, carries Retry-After and X-Skylit-Paused: 1) or credit_check_failed (the credit balance could not be checked; nothing was charged).

  • 504

    gateway_timeout: the request ran longer than 25 seconds and was cancelled. Refunded; retry, or narrow the range.

Response fields

  • symbolstringrequired

    Canonical internal identifier (echo back to /v1/symbols and /v1/history).

  • tickerstringrequired

    Display ticker shown in the picker.

  • descriptionstringrequired
  • exchangestringrequired
  • typestringrequired

    fund covers ETFs, ETCs and mutual funds; dr is a depositary receipt.

    stockfunddrindex
  • kindstring

    Present on indices (index); absent otherwise.

Last updated

Was this page helpful?