Search
K
News & Editorial Layer API (Sandbox)

News & Editorial Layer API

v1.1OAS 3.0

Argaam’s editorial feed: company and market news, full articles with AMP rendering, the market-pulse feed, earnings reports, calendar events, and article types and sources.

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)

Get calendar events for a company

Returns the calendar events for the company identified by stockSymbol.

get
https://api-sandbox.argaam.com/api/v1.1/companies/{stockSymbol}/events

Query Parameters

typestring

Result type filter.

Example:[ "" ]

Path Parameters

stockSymbolstringrequired

Tadawul stock symbol of the company, e.g. 2222 (Saudi Aramco).

Example:2222

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/{stockSymbol}/events
 
200 application/json

Get Argaam editorial articles related to a company.

Returns a list of Argaam-published articles about the company,
filtered by category.

Category values

Value Description
News Latest news items
Analysis In-depth analyst commentary
Report Formal research reports

Each article record contains a title (Arabic + English), publication
timestamp, and a direct URL to the article page on argaam.com.

get
https://api-sandbox.argaam.com/api/v1.1/companies/{stockSymbol}/articles

Query Parameters

Path Parameters

stockSymbolstringrequired

Tadawul stock symbol of the company, e.g. 2222 (Saudi Aramco).

Example:2222

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/{stockSymbol}/articles
 
200 application/json

Get the corporate event calendar for a market.

Returns upcoming and recently completed corporate events for all
companies in the specified market, including:

  • Annual / Extraordinary General Meetings (AGM / EGM)
  • Dividend announcements and payment dates
  • Earnings releases and financial results
  • Investor-day and conference dates

Events are returned in reverse-chronological order (newest first).

Tip: For a single company’s events use
GET /companies/{companyId}/events.

get
https://api-sandbox.argaam.com/api/v1.1/markets/{marketId}/events

Path Parameters

marketIdinteger(int32)required

Market ID (e.g. 1 for Saudi Tadawul).

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

List articles published in a date range, paged.

Returns the firehose of Argaam articles for the requested time
window. Use this endpoint for chronological feeds such as a
news sidebar or mobile timeline.

Example

GET /api/v1.1/news/articles?from=2024-01-01&to=2024-01-31&lang=en&page=1&pageSize=50

Tips

  • Both dates accept ISO-8601 (2024-01-31) or any
    M:System.DateTime.Parse(System.String)-compatible format.
  • Defaults: from = yesterday, to = now, lang = ar,
    pageSize = 200 (max).
get
https://api-sandbox.argaam.com/api/v1.1/news/articles

Query Parameters

fromstring

Start timestamp (inclusive). Defaults to yesterday.

Example:2024-01-01

tostring

End timestamp (inclusive). Defaults to now.

Example:2024-03-31

langstring

Article language. Allowed: ar, en. Default: ar. Defaults to ar.

Default:ar

Example:1

pageinteger(int32)

1-based page number. Default: 1. Defaults to 1.

Default:1

Example:1

pageSizeinteger(int32)

Records per page. Max: 200. Default: 200. Defaults to 200.

Default:200

Example:20

Response

200 application/json

Success

* Additional properties are NOT allowed.
articleIDinteger(int32)
languageIDinteger(int32)
languagestring | nullread-only
titlestring | null
publishedOnstring | null
linkstring | nullread-only
isLinkedboolean
linkedToURLstring | null
isPaidboolean
articleSourceNamestring | null
sourcestring | null
articleTypestring | nullread-only
articleTypeNameArstring | null
articleTypeNameEnstring | null
marketTickerIDsstring | null
marketTickerChartIDsarray | null[string]read-only
companyTickerIDsstring | null
companyTickerChartIDsarray | null[string]read-only
bodystring | null
showDetailsboolean
iconURLstring | null
get/api/v1.1/news/articles
 
200 application/json