Skip to main content
GET
/
v1
/
search
Search symbols
curl --request GET \
  --url https://atlas-api.skylit.ai/v1/search \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://atlas-api.skylit.ai/v1/search"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://atlas-api.skylit.ai/v1/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://atlas-api.skylit.ai/v1/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://atlas-api.skylit.ai/v1/search"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://atlas-api.skylit.ai/v1/search")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://atlas-api.skylit.ai/v1/search")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
[
  {
    "symbol": "SPY",
    "ticker": "SPY",
    "description": "SPDR S&P 500 ETF Trust",
    "exchange": "ARCA",
    "type": "etf"
  },
  {
    "symbol": "SPX",
    "ticker": "SPX",
    "description": "S&P 500 Index",
    "exchange": "NASDAQ",
    "type": "index"
  }
]
{
"error": {
"code": "insufficient_credits",
"message": "<string>"
}
}
{
"error": {
"code": "insufficient_credits",
"message": "Out of credits."
}
}
{
"error": {
"code": "account_suspended",
"message": "Account suspended."
}
}
{
"error": {
"code": "insufficient_credits",
"message": "<string>"
}
}

Authorizations

Authorization
string
header
required

Skylit API key in the Authorization header (Authorization: Bearer <key>). X-API-Key is also accepted. The same key works across Atlas, Heatseeker, and Flowseeker.

Query Parameters

query
string
required

Search text (ticker or name fragment).

Example:

"SP"

limit
integer
default:25

Max results.

Required range: 1 <= x <= 500

Response

Matching symbols.

symbol
string
required

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

ticker
string
required

Display ticker shown in the picker.

description
string
required
exchange
string
required
Example:

"ARCA"

type
enum<string>
required
Available options:
stock,
etf,
index