screening

List Indices

List available stock indices for bulk screening.

Returns every index supported by the bulk-screening engine, along with an estimated ticker count and a short description.

curl example:

curl -X GET "https://api.halalterminal.com/api/screen-bulk/indices" \
     -H "X-API-Key: <API_KEY>"

Python requests example:

import requests

resp = requests.get(
    "https://api.halalterminal.com/api/screen-bulk/indices",
    headers={"X-API-Key": "<API_KEY>"},
)
print(resp.json())

get/api/screen-bulk/indices

Request

Base URL: https://api.halalterminal.com
URL: https://api.halalterminal.com/api/screen-bulk/indices
Auth: API key in header X-API-Key

Response

List of available stock indices with metadata

Example response

{
  "indices": [
    {
      "description": "S&P 500 — large-cap US equities",
      "estimated_count": 503,
      "name": "SP500"
    },
    {
      "description": "Dow Jones Industrial Average",
      "estimated_count": 30,
      "name": "DJIA"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.