Search
K
Search & Discovery Layer API (Production)

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

Companies grouped by country, market, and sector.

Convenience lookup that returns the full universe of listed
companies organised under their country -> market -> sector
path. Often used as the seed dataset for cross-market peer
analysis.

Example

GET /api/v1.1/screener/universe?countryId=1
get
https://api.argaam.com/api/v1.1/screener/universe

Query Parameters

countryIdinteger(int32)

Country ID. Default: 1 (Saudi Arabia). Defaults to 1.

Default:1

Example:1

Response

200

Success

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

Run a screener query

Executes the URL-encoded screener query built from the structure endpoint and returns the matching companies with the requested columns. Compute-heavy: this endpoint carries its own tighter rate limit, independent of the rest of the layer.

get
https://api.argaam.com/api/v1.1/screener/run/{query}

Path Parameters

querystringrequired

URL-encoded screener query string produced by the screener structure endpoint.

Response

200

Success

get/api/v1.1/screener/run/{query}
 
200