sectorIdinteger(int32)
Numeric sector identifier. Use the sector endpoints to list valid values.
Get a by market by marketId
Returns the by market identified by marketId.
get
https://api.argaam.com/api/v1.1/sectors/by-market/{marketId}
Query Parameters
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
* Additional properties are NOT allowed.
marketIDinteger(int32)
sectorIDinteger(int32)
bidstring | null
sectorNameArstring | null
sectorNameEnstring | null
get/api/v1.1/sectors/by-market/{marketId}
Authentication
Path Parameters
Query Parameters
200 application/json
List argaam
Returns the argaam available on this layer.
Paginated: use page and pageSize. Set lang to 1 for English or 2 for Arabic.
get
https://api.argaam.com/api/v1.1/sectors/argaam
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
languageIdinteger(int32)
Response language: 1 = English, 2 = Arabic. Defaults to 1.
Default:1
Example:2
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
sectorNamestring
Sector name to filter by, matched exactly as returned by the sector endpoints.
Default:
Example:[ "" ]
Response
200
Response
200
Success
get/api/v1.1/sectors/argaam
Authentication
Query Parameters
200
List gics
Returns the gics available on this layer.
Paginated: use page and pageSize. Set lang to 1 for English or 2 for Arabic.
get
https://api.argaam.com/api/v1.1/sectors/gics
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
languageIdinteger(int32)
Response language: 1 = English, 2 = Arabic. Defaults to 1.
Default:1
Example:2
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
Response
200
Response
200
Success
get/api/v1.1/sectors/gics
Authentication
Query Parameters
200
Get a data by marketId
Returns the data identified by marketId.
get
https://api.argaam.com/api/v1.1/sectors/data/{marketId}
Query Parameters
sectorIdinteger(int32)
Numeric sector identifier. Use the sector endpoints to list valid values.
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
* Additional properties are NOT allowed.
marketIDinteger(int32)
sectorIDinteger(int32)
bidstring | null
tradingDatestring | null
openValuenumber | null(double)
closeValuenumber | null(double)
highnumber | null(double)
lownumber | null(double)
changenumber | null(double)
volumenumber | null(double)
amountnumber | null(double)
percentageChangenumber | null(double)
get/api/v1.1/sectors/data/{marketId}
Authentication
Path Parameters
Query Parameters
200 application/json
Get historical series for a data
Returns the historical series for the data identified by marketId.
Bound the result with the from and to date parameters.
get
https://api.argaam.com/api/v1.1/sectors/data/{marketId}/history
Query Parameters
sectorIdinteger(int32)
Numeric sector identifier. Use the sector endpoints to list valid values.
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
* Additional properties are NOT allowed.
marketIDinteger(int32)
sectorIDinteger(int32)
bidstring | null
tradingDatestring | null
openValuenumber | null(double)
closeValuenumber | null(double)
highnumber | null(double)
lownumber | null(double)
volumenumber | null(double)
get/api/v1.1/sectors/data/{marketId}/history
Authentication
Path Parameters
Query Parameters
200 application/json