Success
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-sandbox.argaam.com/api/v1.1/screener/fields/config
Response
200
Response
200
get/api/v1.1/screener/fields/config
Authentication
200
List sectors
Returns the sectors available on this layer.
get
https://api-sandbox.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
Response
200
Success
get/api/v1.1/screener/sectors
Authentication
Query Parameters
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-sandbox.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
Response
200
Success
get/api/v1.1/screener/universe
Authentication
Query Parameters
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-sandbox.argaam.com/api/v1.1/screener/run/{query}
Path Parameters
querystringrequired
URL-encoded screener query string produced by the screener structure endpoint.
Response
200
Response
200
Success
get/api/v1.1/screener/run/{query}
Authentication
Path Parameters
200
Get peer companies
Returns the peer group for the requested company - sector and size comparable listings used for relative valuation.
get
https://api-sandbox.argaam.com/api/v1.1/screener/peers
Response
200
Response
200
Success
get/api/v1.1/screener/peers
Authentication
200