Search
K
Projects & Capital Investments Layer API (Sandbox)

Projects & Capital Investments Layer API

v1.1OAS 3.0

Capital projects and investments: projects by market and by company, detailed project records, and company key developments — for backlog and capex analysis.

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 key developments for a company

Returns the key developments for the company identified by stockSymbol.

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

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

List projects in a market (paged).

Returns active and recently completed projects in the
requested market. Useful for building regional project
pipelines dashboards.

Example

GET /api/v1.1/projects/by-market/1?page=1&pageSize=20
get
https://api-sandbox.argaam.com/api/v1.1/projects/by-market/{marketId}

Query Parameters

pageinteger(int32)

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

Default:1

Example:1

pageSizeinteger(int32)

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

Default:10

Example:20

Path Parameters

marketIdinteger(int32)required

Market ID.

Example:3

Response

200

Success

get/api/v1.1/projects/by-market/{marketId}
 
200