Search
K
Market Data Layer API (Sandbox)

Market Data Layer API

v1.1OAS 3.0

Near real-time and historical market data for Tadawul and international equities and indices. Company quotes, intraday and end-of-day price history, market and sector performance, top movers, and stock classifications.

API Base URL
  • Server 1:https://api-sandbox.argaam.com

    Argaam API Gateway (Sandbox)

Security
ApiKeyAuth (apiKey)

An API key is a token that you provide when making API calls. Include the token in a header parameter called apikey.

Example: apikey: 123

ApiKeyAuthQuery (apiKey)

An API key is a token that you provide when making API calls. Include the token in a query parameter called apikey.

Example: ?apikey=123

Additional Information
Contact Argaam IT (developer@argaam.com)

Search and list companies (paged).

Returns a paginated, searchable list of all companies available
in the Argaam database.

Search using the ?q= parameter — it matches against company
name (both Arabic and English) and ticker symbol.

Filter by market using ?marketIds=1,2,4 (comma-separated).

Pagination is controlled by ?page= (1-based) and ?pageSize=.

Each result record contains: CompanyID, CompanyNameEn,
CompanyNameAr, MarketName, Ticker, and LogoURL.

Tip: Once you have a company ID, retrieve its full profile with
GET /companies/{id}/profile. To look up by ticker symbol use
GET /companies/by-symbol/{symbol}.

get
https://api-sandbox.argaam.com/api/v1.1/companies

Query Parameters

langinteger(int32)

Language ID: 1 = English (default), 2 = Arabic. Defaults to 1.

Default:1

Example:1

qstring

Search term (optional). Matched against name and ticker.

Default:

Example:[ "" ]

pageinteger(int32)

Page number (1-based). Default: 1. Defaults to 1.

Default:1

Example:1

pageSizeinteger(int32)

Records per page. Default: 20. Defaults to 20.

Default:20

Example:20

userIdinteger(int32)

Optional user ID for personalized watchlist data. Default: 0. Defaults to 0.

Default:0

Example:0

marketIdsstring

Comma-separated market IDs to filter by (e.g. 1,2). Default: all markets.

Default:

Example:1

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

Look up a company by its trading symbol (ticker).

Resolves a ticker symbol to the full company profile. Useful for
building widgets where the user types in a symbol (e.g. 2222,
SABIC) and you need the canonical company ID and metadata.

The symbol match is case-insensitive.

Returns 404 when no company with the given symbol is found.

Tip: For shareholders by symbol use
GET /companies/by-symbol/{symbol}/shareholders.
For analyst estimates by symbol use
GET /companies/by-symbol/{symbol}/analyst-estimates.

get
https://api-sandbox.argaam.com/api/v1.1/companies/by-symbol/{symbol}

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

Path Parameters

symbolstringrequired

Company ticker symbol, e.g. 2222. Equivalent to stockSymbol on other endpoints.

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/companies/by-symbol/{symbol}
 
200 application/json