News & Editorial Layer API (Sandbox)

Home-page main news feed.

Curated headline list designed for the Argaam home page or
any landing-page widget. Optionally filter by stock symbol.

Example

GET /api/v1.1/news/home?sectionId=2&marketId=1&languageId=1&stockSymbol=2222
get
https://api-sandbox.argaam.com/api/v1.1/news/home

Query Parameters

sectionIdinteger(int32)

News section identifier used to group articles (e.g. announcements, analysis).

Example:26

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

stockSymbolstring

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

Default:

Example:2222

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

Example:20

Response

200

Success

get/api/v1.1/news/home
 
200

Articles by date range with optional filters.

Calendar-driven listing: combines arbitrary date range with
optional company / paging.

Example

GET /api/v1.1/news/articles/by-date?languageId=2&from=2024-01-01&to=2024-01-31&stockSymbol=2222&page=1&pageSize=50
get
https://api-sandbox.argaam.com/api/v1.1/news/articles/by-date

Query Parameters

languageIdinteger(int32)

Response language: 1 = English, 2 = Arabic. Defaults to 1.

Example:2

fromstring

Start of the date range, inclusive. Format YYYY-MM-DD.

Default:

Example:2024-01-01

tostring

End of the date range, inclusive. Format YYYY-MM-DD.

Default:

Example:2024-03-31

stockSymbolstring

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

Default:

Example:2222

pageinteger(int32)

1-based page number. Defaults to 1.

Default:0

Example:1

pageSizeinteger(int32)

Number of records per page. Defaults to the endpoint’s standard page size; large values are capped server-side.

Default:0

Example:20

Response

200

Success

get/api/v1.1/news/articles/by-date
 
200

List earnings reports

Returns the earnings reports available on this layer.

Paginated: use page and pageSize. Bound the result with the from and to date parameters. Set lang to 1 for English or 2 for Arabic.

get
https://api-sandbox.argaam.com/api/v1.1/news/earning-reports

Query Parameters

languageIdinteger(int32)

Response language: 1 = English, 2 = Arabic. Defaults to 1.

Example:2

fromstring

Start of the date range, inclusive. Format YYYY-MM-DD.

Default:

Example:2024-01-01

tostring

End of the date range, inclusive. Format YYYY-MM-DD.

Default:

Example:2024-03-31

stockSymbolstring

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

Default:

Example:2222

pageinteger(int32)

1-based page number. Defaults to 1.

Default:0

Example:1

pageSizeinteger(int32)

Number of records per page. Defaults to the endpoint’s standard page size; large values are capped server-side.

Default:0

Example:20

Response

200

Success

get/api/v1.1/news/earning-reports
 
200

Available article type taxonomies.

Article types group editorial content into broad categories
(news, analysis, press release, etc.). Use to build filter UIs.

get
https://api-sandbox.argaam.com/api/v1.1/news/article-types

Response

200 application/json

Success

* Additional properties are NOT allowed.
articleTypeIDinteger(int32)
nameArstring | null
nameEnstring | null
argaamIDinteger | null(int32)
usedInChartboolean
get/api/v1.1/news/article-types
 
200 application/json

Article source registry (publishers, agencies).

Returns the list of upstream sources Argaam aggregates from.
Useful when displaying article attribution.

get
https://api-sandbox.argaam.com/api/v1.1/news/article-sources

Query Parameters

langstring

Response language: 1 = English, 2 = Arabic. Defaults to 1.

Default:ar

Example:1

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

Example:20

Response

200 application/json

Success

* Additional properties are NOT allowed.
articleSourceIDinteger(int32)
articleSourceNamestring | null
languageIDinteger(int32)
parentArticleSourceIDinteger | null(int32)
isActiveForStatisticboolean
get/api/v1.1/news/article-sources
 
200 application/json