countryIdinteger(int32)
Country ID. Default: 1 (Saudi Arabia). Defaults to 1.
Default:1
Example:1
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
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
Get the country → markets → sectors → companies discovery tree.
Returns the full hierarchical discovery tree used to populate
cascading dropdowns in the charting tool. Each node contains
an id, name, and children array.
Tip: For a symbol-specific pre-selection use
GET /charts/universe/by-symbol?stockSymbol={symbol}.
cURL Example
curl -X GET "https://api.argaam.com/api/v1.1/charts/universe?countryId=1" \
-H "Accept: application/json"
get
https://api-sandbox.argaam.com/api/v1.1/charts/universe
Query Parameters
countryIdinteger(int32)
Country ID. Default: 1 (Saudi Arabia). Defaults to 1.
Default:1
Example:1
Response
200 application/json
Response
200 application/json
Discovery tree returned.
ApiV1ResponseOfChartUniverseResponse
Standardized successful API response wrapper for v1.0.0 endpoints.
* Additional properties are NOT allowed.
successboolean
Always true for successful responses.
apiVersionstring | null
Semantic API version (e.g., “1.0.0”).
timestampstring(date-time)
UTC timestamp when the response was generated.
requestIdstring | null
Unique request identifier for tracing.
dataobject
* Additional properties are NOT allowed.
Show Child Parameters
metaobject
Pagination and metadata information for collection responses.
* Additional properties are NOT allowed.
Show Child Parameters
rateLimitobject
Rate limit information returned with each response.
* Additional properties are NOT allowed.
Show Child Parameters
get/api/v1.1/charts/universe
Authentication
Query Parameters
200 application/json
Get the discovery tree pre-selected to a specific trading symbol.
Convenience variant of GET /charts/universe that pre-populates the
discovery tree with the company matching the supplied ticker symbol.
Useful for deep-linking directly to a stock chart from an external page.
Tip: Use GET /companies/by-symbol/{symbol} to resolve the company ID
if you only have the ticker and need additional metadata.
get
https://api-sandbox.argaam.com/api/v1.1/charts/universe/by-symbol
Query Parameters
countryIdinteger(int32)
Country ID. Default: 1 (Saudi Arabia). Defaults to 1.
Default:1
Example:1
stockSymbolstring
Trading symbol / ticker to pre-select (e.g. 2222). Defaults to 0.
Default:0
Example:2222
Response
200 application/json
Response
200 application/json
Discovery tree with pre-selected company returned.
ApiV1ResponseOfChartUniverseBySymbolResponse
Standardized successful API response wrapper for v1.0.0 endpoints.
* Additional properties are NOT allowed.
successboolean
Always true for successful responses.
apiVersionstring | null
Semantic API version (e.g., “1.0.0”).
timestampstring(date-time)
UTC timestamp when the response was generated.
requestIdstring | null
Unique request identifier for tracing.
dataobject
* Additional properties are NOT allowed.
Show Child Parameters
metaobject
Pagination and metadata information for collection responses.
* Additional properties are NOT allowed.
Show Child Parameters
rateLimitobject
Rate limit information returned with each response.
* Additional properties are NOT allowed.
Show Child Parameters
get/api/v1.1/charts/universe/by-symbol
Authentication
Query Parameters
200 application/json