Get Stock Basic Info Screener by Country

curl --request GET \
  --url https://data-tools.prd.arrays.org/api/v1/stocks/screener/basic-info/country \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://data-tools.prd.arrays.org/api/v1/stocks/screener/basic-info/country"

headers = {"X-API-Key": "<api-key>"}

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

print(response.text)

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://data-tools.prd.arrays.org/api/v1/stocks/screener/basic-info/country', 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://data-tools.prd.arrays.org/api/v1/stocks/screener/basic-info/country",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$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://data-tools.prd.arrays.org/api/v1/stocks/screener/basic-info/country"

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

	req.Header.Add("X-API-Key", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://data-tools.prd.arrays.org/api/v1/stocks/screener/basic-info/country")

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

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "symbol": "<string>",
      "type": "<string>",
      "value": "<string>"
    }
  ],
  "error": {
    "code": "RESOURCE_NOT_FOUND",
    "details": [
      {
        "field": "<string>",
        "got": "<string>",
        "reason": "<string>"
      }
    ],
    "docs_url": "<string>",
    "examples": [
      "<string>"
    ],
    "hint": "<string>",
    "message": "The requested resource was not found.",
    "suggestions": [
      "<string>"
    ]
  },
  "metadata": "<unknown>",
  "pagination": "<unknown>",
  "request_id": "<string>",
  "success": true
}

{
  "data": "<unknown>",
  "error": {
    "code": "RESOURCE_NOT_FOUND",
    "details": [
      {
        "field": "<string>",
        "got": "<string>",
        "reason": "<string>"
      }
    ],
    "docs_url": "<string>",
    "examples": [
      "<string>"
    ],
    "hint": "<string>",
    "message": "The requested resource was not found.",
    "suggestions": [
      "<string>"
    ]
  },
  "metadata": "<unknown>",
  "pagination": "<unknown>",
  "request_id": "<string>",
  "success": true
}

{
  "data": "<unknown>",
  "error": {
    "code": "RESOURCE_NOT_FOUND",
    "details": [
      {
        "field": "<string>",
        "got": "<string>",
        "reason": "<string>"
      }
    ],
    "docs_url": "<string>",
    "examples": [
      "<string>"
    ],
    "hint": "<string>",
    "message": "The requested resource was not found.",
    "suggestions": [
      "<string>"
    ]
  },
  "metadata": "<unknown>",
  "pagination": "<unknown>",
  "request_id": "<string>",
  "success": true
}

Stock

Get Stock Basic Info Screener by Country

OpenAPI JSON Spec Retrieve a list of stock companies filtered by country. Returns basic company information including ticker, name, sector, industry, exchange, and country.

Country Codes Supports ISO 3166-1 alpha-2 country codes. 57 countries are supported:

AE (United Arab Emirates), AR (Argentina), AU (Australia), BE (Belgium), BM (Bermuda), BR (Brazil), BS (Bahamas), CA (Canada), CH (Switzerland), CI (Côte d’Ivoire), CL (Chile), CN (China), CO (Colombia), CR (Costa Rica), CY (Cyprus), DE (Germany), DK (Denmark), ES (Spain), FI (Finland), FR (France), GB (United Kingdom), GG (Guernsey), GI (Gibraltar), GR (Greece), HK (Hong Kong), ID (Indonesia), IE (Ireland), IL (Israel), IN (India), IS (Iceland), IT (Italy), JE (Jersey), JO (Jordan), JP (Japan), KR (South Korea), KY (Cayman Islands), KZ (Kazakhstan), LU (Luxembourg), MC (Monaco), MO (Macao), MX (Mexico), MY (Malaysia), NL (Netherlands), NO (Norway), PA (Panama), PE (Peru), PH (Philippines), SE (Sweden), SG (Singapore), TH (Thailand), TR (Turkey), TW (Taiwan), US (United States), UY (Uruguay), VG (British Virgin Islands), VN (Vietnam), ZA (South Africa). ETF filter: results default to non-ETF stocks (symbol_type=stock). Pass symbol_type=etf to return ETFs (e.g. SPY, QQQ).

GET

stocks

screener

basic-info

country

Get Stock Basic Info Screener by Country

curl --request GET \
  --url https://data-tools.prd.arrays.org/api/v1/stocks/screener/basic-info/country \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://data-tools.prd.arrays.org/api/v1/stocks/screener/basic-info/country"

headers = {"X-API-Key": "<api-key>"}

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

print(response.text)

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://data-tools.prd.arrays.org/api/v1/stocks/screener/basic-info/country', 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://data-tools.prd.arrays.org/api/v1/stocks/screener/basic-info/country",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$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://data-tools.prd.arrays.org/api/v1/stocks/screener/basic-info/country"

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

	req.Header.Add("X-API-Key", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://data-tools.prd.arrays.org/api/v1/stocks/screener/basic-info/country")

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

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "symbol": "<string>",
      "type": "<string>",
      "value": "<string>"
    }
  ],
  "error": {
    "code": "RESOURCE_NOT_FOUND",
    "details": [
      {
        "field": "<string>",
        "got": "<string>",
        "reason": "<string>"
      }
    ],
    "docs_url": "<string>",
    "examples": [
      "<string>"
    ],
    "hint": "<string>",
    "message": "The requested resource was not found.",
    "suggestions": [
      "<string>"
    ]
  },
  "metadata": "<unknown>",
  "pagination": "<unknown>",
  "request_id": "<string>",
  "success": true
}

{
  "data": "<unknown>",
  "error": {
    "code": "RESOURCE_NOT_FOUND",
    "details": [
      {
        "field": "<string>",
        "got": "<string>",
        "reason": "<string>"
      }
    ],
    "docs_url": "<string>",
    "examples": [
      "<string>"
    ],
    "hint": "<string>",
    "message": "The requested resource was not found.",
    "suggestions": [
      "<string>"
    ]
  },
  "metadata": "<unknown>",
  "pagination": "<unknown>",
  "request_id": "<string>",
  "success": true
}

{
  "data": "<unknown>",
  "error": {
    "code": "RESOURCE_NOT_FOUND",
    "details": [
      {
        "field": "<string>",
        "got": "<string>",
        "reason": "<string>"
      }
    ],
    "docs_url": "<string>",
    "examples": [
      "<string>"
    ],
    "hint": "<string>",
    "message": "The requested resource was not found.",
    "suggestions": [
      "<string>"
    ]
  },
  "metadata": "<unknown>",
  "pagination": "<unknown>",
  "request_id": "<string>",
  "success": true
}

Authorizations

X-API-Key

string

header

required

API Key authentication. Example: "your-api-key-here"

Query Parameters

country

enum<string>

required

Country code (ISO 3166-1 alpha-2)

Available options:

AE,

AR,

AU,

BE,

BM,

BR,

BS,

CA,

CH,

CI,

CL,

CN,

CO,

CR,

CY,

DE,

DK,

ES,

FI,

FR,

GB,

GG,

GI,

GR,

HK,

ID,

IE,

IL,

IN,

IS,

IT,

JE,

JO,

JP,

KR,

KY,

KZ,

LU,

MC,

MO,

MX,

MY,

NL,

NO,

PA,

PE,

PH,

SE,

SG,

TH,

TR,

TW,

US,

UY,

VG,

VN,

ZA

symbol_type

enum<string>

Asset type filter. Valid values: stock (non-ETF), etf. Optional, defaults to stock.

Available options:

stock,

etf

Response

Successfully retrieved stock basic info by country

data

object[]

Show child attributes

error

object

Show child attributes

metadata

any

pagination

any

request_id

string

success

boolean

Overview

Endpoints

Get Stock Basic Info Screener by Country

Authorizations

Query Parameters

Response