marketIdinteger(int32)required
Numeric market identifier (e.g. 1 = Tadawul / Saudi main market). Use GET /api/v1.1/markets to list valid values.
Example:3
Get companies for a market
Returns the companies for the market identified by marketSymbol.
get
https://api-sandbox.argaam.com/api/v1.1/markets/{marketId}/companies
Path Parameters
Response
200 application/json
Response
200 application/json
Success
ApiV1Response
* Additional properties are NOT allowed.
successboolean
apiVersionstring | null
timestampstring(date-time)
requestIdstring | null
data
metaobject
* Additional properties are NOT allowed.
Show Child Parameters
rateLimitobject
* Additional properties are NOT allowed.
Show Child Parameters
get/api/v1.1/markets/{marketId}/companies
Authentication
Path Parameters
200 application/json
Get data for a international
Returns the data for the international identified by marketSymbol.
get
https://api-sandbox.argaam.com/api/v1.1/markets/international/{marketId}/data
Path Parameters
marketIdinteger(int32)required
Numeric market identifier (e.g. 1 = Tadawul / Saudi main market). Use GET /api/v1.1/markets to list valid values.
Example:3
Response
200 application/json
Response
200 application/json
Success
ApiV1Response
* Additional properties are NOT allowed.
successboolean
apiVersionstring | null
timestampstring(date-time)
requestIdstring | null
data
metaobject
* Additional properties are NOT allowed.
Show Child Parameters
rateLimitobject
* Additional properties are NOT allowed.
Show Child Parameters
get/api/v1.1/markets/international/{marketId}/data
Authentication
Path Parameters
200 application/json
Get historical series for a international
Returns the historical series for the international identified by marketSymbol.
Bound the result with the from and to date parameters.
get
https://api-sandbox.argaam.com/api/v1.1/markets/international/{marketId}/data/history
Query Parameters
fromstring
Start of the date range, inclusive. Format YYYY-MM-DD.
Example:2024-01-01
tostring
End of the date range, inclusive. Format YYYY-MM-DD.
Example:2024-03-31
Path Parameters
marketIdinteger(int32)required
Numeric market identifier (e.g. 1 = Tadawul / Saudi main market). Use GET /api/v1.1/markets to list valid values.
Example:3
Response
200 application/json
Response
200 application/json
Success
ApiV1Response
* Additional properties are NOT allowed.
successboolean
apiVersionstring | null
timestampstring(date-time)
requestIdstring | null
data
metaobject
* Additional properties are NOT allowed.
Show Child Parameters
rateLimitobject
* Additional properties are NOT allowed.
Show Child Parameters
get/api/v1.1/markets/international/{marketId}/data/history
Authentication
Path Parameters
Query Parameters
200 application/json
Get top movers for a market
Returns the top movers for the market identified by marketSymbol.
get
https://api-sandbox.argaam.com/api/v1.1/markets/{marketId}/movers
Path Parameters
marketIdinteger(int32)required
Numeric market identifier (e.g. 1 = Tadawul / Saudi main market). Use GET /api/v1.1/markets to list valid values.
Example:3
Response
200 application/json
Response
200 application/json
Success
ApiV1Response
* Additional properties are NOT allowed.
successboolean
apiVersionstring | null
timestampstring(date-time)
requestIdstring | null
data
metaobject
* Additional properties are NOT allowed.
Show Child Parameters
rateLimitobject
* Additional properties are NOT allowed.
Show Child Parameters
get/api/v1.1/markets/{marketId}/movers
Authentication
Path Parameters
200 application/json
Get sectors for a market
Returns the sectors for the market identified by marketSymbol.
Paginated: use page and pageSize. Set lang to 1 for English or 2 for Arabic.
get
https://api-sandbox.argaam.com/api/v1.1/markets/{marketId}/sectors
Query Parameters
langinteger(int32)
Response language: 1 = English, 2 = Arabic. Defaults to 1.
Default:1
Example:1
sectorNamestring
Sector name to filter by, matched exactly as returned by the sector endpoints.
Default:
Example:[ "" ]
pageinteger(int32)
1-based page number. Defaults to 1.
Default:1
Example:1
pageSizeinteger(int32)
Number of records per page. Defaults to the endpoint’s standard page size; large values are capped server-side.
Default:10
Example:20
Path Parameters
marketIdinteger(int32)required
Numeric market identifier (e.g. 1 = Tadawul / Saudi main market). Use GET /api/v1.1/markets to list valid values.
Example:3
Response
200 application/json
Response
200 application/json
Success
ApiV1Response2
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.
data
The response payload.
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/markets/{marketId}/sectors
Authentication
Path Parameters
Query Parameters
200 application/json