Search & Discovery Layer API (Sandbox)

Search & Discovery Layer API

Unified search across companies, articles, funds, and projects

Cross-cutting free-text search across the Argaam catalog – companies, news/articles, funds, and projects – filtered by market and language, and paginated.

Example

GET /api/v1.1/search/get-search-result/aramco/3/2/All/1/10
get
https://api-sandbox.argaam.com/api/v1.1/search/get-search-result/{searchterm}/{marketid}/{languageid}/{type}/{pageno}/{limit}

Path Parameters

searchtermstringrequired

Free-text search query.

Example:aramco

marketidstringrequired

Market ID(s) to scope the search to. Use GET /api/v1.1/markets to list valid values.

Example:3

languageidinteger(int32)required

Language ID (e.g. 2 = English).

Example:2

typestringrequired

Result type filter (e.g. All, Company, Article, Fund, Project). Must be a recognized value – unrecognized values return 404.

Example:All

pagenointeger(int32)required

1-based page number.

Example:1

limitinteger(int32)required

Page size / max results to return.

Example:10

Response

200

Success

get/api/v1.1/search/get-search-result/{searchterm}/{marketid}/{languageid}/{type}/{pageno}/{limit}
 
200

ArticleDetails

object
* Additional properties are NOT allowed.
articleIDinteger(int32)
languageIDinteger(int32)
languagestringread-only
titlestring
bodystring
shortURLstring
publishedOnstring
articleSourceNamestring
articleTypestringread-only
articleTypeNameArstring
articleTypeNameEnstring
marketTickerIDsstring
marketTickerChartIDsarray[string]read-only
companyTickerIDsstring
companyTickerChartIDsarray[string]read-only
customAMPCssstring
Example

Article

object
* Additional properties are NOT allowed.
articleIDinteger(int32)
languageIDinteger(int32)
languagestringread-only
titlestring
publishedOnstring
linkstringread-only
isLinkedboolean
linkedToURLstring
isPaidboolean
articleSourceNamestring
sourcestring
articleTypestringread-only
articleTypeNameArstring
articleTypeNameEnstring
marketTickerIDsstring
marketTickerChartIDsarray[string]read-only
companyTickerIDsstring
companyTickerChartIDsarray[string]read-only
bodystring
showDetailsboolean
iconURLstring
Example

ApiV1Meta

object
* Additional properties are NOT allowed.
pageinteger(int32)
pageSizeinteger(int32)
totalRecordsinteger(int32)
totalPagesinteger(int32)read-only
hasNextPagebooleanread-only
hasPreviousPagebooleanread-only
Example

ApiV1RateLimit

object
* Additional properties are NOT allowed.
limitinteger(int32)
remaininginteger(int32)
resetstring(date-time)
Example