Enterprise API Documentation

count=all

Total number of unique trading symbols.

{
  "Status": "OK",
  "Result": {
    "all": 12345
  }
}

count=country

Distinct symbols grouped by country (case-insensitive).

{
  "Status": "OK",
  "Result": {
    "Countries": [
      {
        "Name": "USA",
        "Count": 8500
      },
      {
        "Name": "Canada",
        "Count": 1200
      }
    ]
  }
}

count=sector

Distinct symbols grouped by sector.

{
  "Status": "OK",
  "Result": {
    "Sectors": [
      {
        "Name": "Technology",
        "Count": 2500
      },
      {
        "Name": "Healthcare",
        "Count": 1800
      }
    ]
  }
}

count=industry

Distinct symbols grouped by industry.

{
  "Status": "OK",
  "Result": {
    "Industries": [
      {
        "Name": "Consumer Electronics",
        "Count": 1500
      },
      {
        "Name": "Software",
        "Count": 1200
      },
      {
        "Name": "Pharmaceuticals",
        "Count": 800
      }
    ]
  }
}

count=exchange_short_name

Distinct symbols grouped by exchange.

{
  "Status": "OK",
  "Result": {
    "Exchanges": [
      {
        "Name": "NASDAQ",
        "Count": 4500
      },
      {
        "Name": "NYSE",
        "Count": 3800
      },
      {
        "Name": "TSX",
        "Count": 1200
      }
    ]
  }
}

count=verdict

Distinct symbols grouped by Shariah verdict.

{
  "Status": "OK",
  "Result": {
    "Verdicts": [
      {
        "Name": "permissible",
        "Count": 8500
      },
      {
        "Name": "non_permissible",
        "Count": 3500
      },
      {
        "Name": "unknown",
        "Count": 345
      }
    ]
  }
}

count=new

New companies added within the last ~30 days.

{
  "Status": "OK",
  "Result": {
    "New companies": [
      {
        "Name": "permissible",
        "Count": 45
      },
      {
        "Name": "non permissible",
        "Count": 12
      }
    ],
    "Total": 57
  }
}

List: all

Returns latest record per symbol. Supports filters, sorting, pagination.

{
  "Status": "OK",
  "Result": {
    "Symbols": [
      {
        "trading_symbol": "AAPL",
        "company_name": "Apple Inc.",
        "sector": "Technology",
        "industry": "Consumer Electronics",
        "country": "USA",
        "exchange_short_name": "NASDAQ",
        "shariah_verdict": "Permissible",
        "market_cap": 2940000000000,
        "total_debt": 120000000000,
        "total_cash_and_securities": 65000000000,
        "ratio_total_debt_to_market_cap_24": 0.04,
        "ratio_cash_and_securities_to_market_cap_24": 0.02,
        "period_report_date": "2024-12-31",
        "filled_date": "2025-02-10"
      }
    ],
    "Pagination": {
      "total_count": 1234,
      "start": 0,
      "length": 10
    }
  }
}

List: new

Records within last ~30 days; supports verdict filter and new-style filters.

List: availabledates

Requires trading_symbol; returns distinct report dates.

pool_status

For user's group pool; no extra params allowed.

index_status

For user's personal index; no extra params allowed.

Symbol (latest or range)

Details for a single symbol (with optional date range).

Symbol history

Full history for a single symbol.

Filtering

Use Django-style operators with __: exact, iexact, contains, icontains, lt, lte, gt, gte.

Supported filter fields: country, sector, industry, exchange_short_name, trading_symbol, shariah_verdict, market_cap, total_debt, total_cash_and_securities

Sorting

Allow sorting on list/search results. sort_order is asc or desc.

Pagination

Pagination parameters:

• start: Starting position (0-based)
• length: Number of records (1-20, default 10)

Note: If start exceeds total count, returns empty result. If length > 20, automatically limited to 20.

Localization

Language support: en | ru | kk (default en).

Localized content: sector names, industry names, shariah verdict descriptions, error messages

list=all

• You may combine multiple new-style filters field__op=value
• Old-style filters — only one at a time
• May be combined with sort_field/sort_order and start/length

list=new

• Only old-style verdict is allowed
• New __ filters are also supported

availabledates

• Requires trading_symbol (or symbol)
• Sorting applies to dates; pagination supported

count

• Mutually exclusive with other primary parameters
• Supports lng parameter
• Supports filters for some count types

Add symbol to index

{
  "Status": "OK",
  "Message": "Symbol AAPL added to index successfully"
}

Remove symbol from index

{
  "Status": "OK",
  "Message": "Symbol AAPL removed from index successfully"
}

Example: Bad Request (400)

{
  "Status": "Bad",
  "Message": "Invalid value for count: invalid_param",
  "Error_type": "INVALID_VALUE",
  "Result": null
}

Example: Unauthorized (401)

{
  "Status": "Bad",
  "Message": "Invalid API key",
  "Error_type": "API_KEY_INVALID",
  "Result": null
}

Example: Forbidden (403)

{
  "Status": "Bad",
  "Message": "Subscription has expired",
  "Error_type": "SUBSCRIPTION_EXPIRED",
  "Result": null
}

Example: Internal Server Error (500)

{
  "Status": "Error",
  "Message": "Internal server error",
  "Error_type": "INTERNAL_SERVER_ERROR",
  "Result": null
}

count=all

Total number of unique trading symbols.

{
  "Status": "OK",
  "Message": "",
  "Error_type": "",
  "Result": {
    "all": 12345
  }
}

count=country

Distinct symbols grouped by country (case-insensitive).

{
  "Status": "OK",
  "Message": "",
  "Error_type": "",
  "Result": {
    "countries": [
      {
        "Name": "usa",
        "Count": 8500
      },
      {
        "Name": "canada",
        "Count": 1200
      }
    ]
  }
}

count=sector

Distinct symbols grouped by sector.

{
  "Status": "OK",
  "Message": "",
  "Error_type": "",
  "Result": {
    "sectors": [
      {
        "Name": "technology",
        "Count": 2500
      },
      {
        "Name": "healthcare",
        "Count": 1800
      }
    ]
  }
}

count=industry

Distinct symbols grouped by industry.

{
  "Status": "OK",
  "Message": "",
  "Error_type": "",
  "Result": {
    "industries": [
      {
        "Name": "consumer electronics",
        "Count": 1500
      },
      {
        "Name": "software",
        "Count": 1200
      },
      {
        "Name": "pharmaceuticals",
        "Count": 800
      }
    ]
  }
}

count=exchange_short_name

Distinct symbols grouped by exchange.

{
  "Status": "OK",
  "Message": "",
  "Error_type": "",
  "Result": {
    "exchange_short_name": [
      {
        "Name": "nasdaq",
        "Count": 4500
      },
      {
        "Name": "nyse",
        "Count": 3800
      },
      {
        "Name": "tsx",
        "Count": 1200
      }
    ]
  }
}

count=verdict

Distinct symbols grouped by Shariah verdict.

{
  "Status": "OK",
  "Message": "",
  "Error_type": "",
  "Result": {
    "verdict": [
      {
        "Name": "permissible",
        "Count": 8500
      },
      {
        "Name": "non_permissible",
        "Count": 3500
      },
      {
        "Name": "unknown",
        "Count": 345
      }
    ]
  }
}

count=new

New companies added within the last ~30 days.

{
  "Status": "OK",
  "Message": "",
  "Error_type": "",
  "Result": {
    "new": [
      {
        "Name": "permissible",
        "Count": 45
      },
      {
        "Name": "non_permissible",
        "Count": 12
      }
    ],
    "Total": 57
  }
}

List: all

Returns latest record per symbol. Supports filters, sorting, pagination.

{
  "Status": "OK",
  "Message": "",
  "Error_type": "",
  "Result": {
    "Symbols": [
      {
        "trading_symbol": "AAPL",
        "company_name": "Apple Inc.",
        "sector": "Technology",
        "industry": "Consumer Electronics",
        "country": "USA",
        "exchange_short_name": "NASDAQ",
        "shariah_verdict": "Permissible",
        "market_cap": 2940000000000,
        "total_debt": 120000000000,
        "total_cash_and_securities": 65000000000,
        "ratio_total_debt_to_market_cap_24": 0.04,
        "ratio_cash_and_securities_to_market_cap_24": 0.02,
        "period_report_date": "2024-12-31",
        "filled_date": "2025-02-10"
      }
    ],
    "Pagination": {
      "total_count": 1234,
      "start": 0,
      "length": 10,
      "current_page": 1,
      "total_pages": 124,
      "has_next": true,
      "has_previous": false
    }
  }
}

List: new

Records within last ~30 days; supports verdict filter and new-style filters.

List: availabledates

Requires trading_symbol; returns distinct report dates.

List: pool_status

Returns detailed status information for the user's group pool. No extra parameters allowed.

Returns metadata about the active pool including last update time, composition, and statistics.

List: index_status

Returns detailed status information for the user's personal custom index. No extra parameters allowed.

Returns metadata about the custom index including composition, weighting, and performance metrics.

pool_status

For user's group pool; no extra params allowed.

index_status

For user's personal index; no extra params allowed.

Symbol (latest or range)

Details for a single symbol (with optional date range).

Symbol history

Full history for a single symbol.

Full-Text Search

Search for instruments by name, trading symbol, or other attributes with full-text capabilities.

Supported Parameters:

• search - Search query term (full-text across all fields)
• start - Starting position (0-based, default: 0)
• length - Number of results per page (default: 10, max: 20)
• All standard filters (country, sector, industry, etc.)

Get Pool Details

Retrieve detailed information about a specific pool from your group.

Parameters:

• pool - Pool identifier (e.g., ITSX, custom pool name)
• start - Starting position (0-based, default: 0)
• length - Number of results per page (default: 10, max: 20)

Response includes:

• Pool metadata and composition
• Instrument list within the pool
• Last update timestamp

Get Index Details

Retrieve detailed information about a specific custom index.

Parameters:

• index - Index identifier
• start - Starting position (0-based, default: 0)
• length - Number of results per page (default: 10, max: 20)

Response includes:

• Index metadata
• Component instruments
• Historical data availability

Filtering (Enhanced)

Use Django-style operators with __: exact, iexact, contains, icontains, lt, lte, gt, gte.

Supported filter fields: trading_symbol, company_name, country, sector, industry, currency, exchange, exchange_short_name, period_report_date, filled_date, quarter, form, shariah_verdict, shariah_compliance, total_debt, total_debt_to_market_cap, market_cap, market_cap_12, market_cap_24, total_cash_and_securities, total_assets, ratio_cash_and_securities_to_market_cap, and other financial metrics.

Date Range Filtering

Filter results by date ranges using fromdate and todate parameters. Useful for retrieving historical data or recent updates.

Parameters:

• fromdate - Start date (YYYY-MM-DD format)
• todate - End date (YYYY-MM-DD format)
• Can be combined with other filters and sorting

Sorting

Allow sorting on list/search results. sort_order is asc or desc.

Pagination

Pagination parameters for controlling result sets:

• start: Starting position (0-based, default: 0)
• length: Number of records per page (default: 10, max: 20)

Note: If length exceeds 20, it will be automatically limited to 20. If start exceeds the total count, an empty result is returned.

Localization

Language support: en | ru | kk (default en).

Localized content: sector names, industry names, shariah verdict descriptions, error messages

list=all

• You may combine multiple new-style filters field__op=value
• Old-style filters — only one at a time
• May be combined with sort_field/sort_order and start/length

list=new

• Only old-style verdict is allowed
• New __ filters are also supported

availabledates

• Requires trading_symbol (or symbol)
• Sorting applies to dates; pagination supported

count

• Mutually exclusive with other primary parameters
• Supports lng parameter
• Supports filters for some count types

Add symbol to index

{
  "Status": "OK",
  "Message": "Symbol AAPL added to index",
  "Error_type": "",
  "Result": {
    "Index": ["AAPL", "MSFT", "GOOGL"],
    "Pool": {}
  }
}

Remove symbol from index

{
  "Status": "OK",
  "Message": "Symbol AAPL removed from index",
  "Error_type": "",
  "Result": {
    "Index": ["MSFT", "GOOGL"],
    "Pool": {}
  }
}