Search
K
Search & Discovery Layer API (Production)

Search & Discovery Layer API

v1.1OAS 3.0

Cross-cutting discovery and screening: the equity screener (structure, fields, universe, run, peers), the chart universe, and unified company and news lookup.

API Base URL
  • Server 1:https://api.argaam.com

    Argaam API Gateway (Production)

Security
ApiKeyAuth (apiKey)

An API key is a token that you provide when making API calls. Include the token in a header parameter called apikey.

Example: apikey: 123

ApiKeyAuthQuery (apiKey)

An API key is a token that you provide when making API calls. Include the token in a query parameter called apikey.

Example: ?apikey=123

Additional Information
Contact Argaam IT (developer@argaam.com)

Schema describing the screener UI (sections, pages, groups).

Returns the complete screening schema that powers the
Argaam web screener. Use this endpoint as the source of truth
for which fields are available, how they are grouped into
pages/sections, and the default UI layout.

Example

GET /api/v1.1/screener/structure

Response shape

Hierarchical: pages -> sections -> field groups -> fields.
Each field carries display labels (Ar/En), data type, units,
allowed operators, and grouping metadata.

get
https://api.argaam.com/api/v1.1/screener/structure

Response

200

Success

get/api/v1.1/screener/structure
 
200

Per-field configuration (formats, units, allowed operators).

Lighter-weight alternative to /structure: returns just
the field-level metadata without page/section grouping.
Useful when building a custom UI or generating screener
queries programmatically.

Example

GET /api/v1.1/screener/fields/config
get
https://api.argaam.com/api/v1.1/screener/fields/config

Response

200

Success

get/api/v1.1/screener/fields/config
 
200

List sectors

Returns the sectors available on this layer.

get
https://api.argaam.com/api/v1.1/screener/sectors

Query Parameters

marketIdinteger(int32)

Numeric market identifier (e.g. 1 = Tadawul / Saudi main market). Use GET /api/v1.1/markets to list valid values. Defaults to 3.

Default:3

Example:3

Response

200

Success

get/api/v1.1/screener/sectors
 
200