Market Data Layer API (Sandbox)

Get historical series for a market

Returns the historical series for the market identified by marketSymbol.

Bound the result with the from and to date parameters.

get
https://api-sandbox.argaam.com/api/v1.1/markets/{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

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}/data/history
 
200 application/json

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

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

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
 
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

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
 
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

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
 
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

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
 
200 application/json