---
title: "Macroeconomic Layer API"
url: "https://developer.argaam.com/apis/macroeconomic-layer-api-sandbox-v1/versions/e4c9f983-817a-417e-bfa3-115c2b14f8bd"
---

# Macroeconomic Layer API

OpenAPI specification document.

````json
{"openapi":"3.0.1","info":{"title":"Macroeconomic Layer API","description":"Macroeconomic and commodity data: energy and commodity quotes, consumer-goods prices, petrochemical indices and products, shipping and refining margins, and national economic indicators.","contact":{"name":"Argaam IT","url":"https://www.argaam.com","email":"developer@argaam.com"},"version":"v1.1"},"paths":{"/api/v1.1/commodities":{"get":{"tags":["Commodities"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Commodity"}}}}}},"summary":"List all tracked commodities.","description":"Returns the full catalogue Argaam tracks: codes, names, units,\r\nreference exchanges, and category (energy, metals, agri, etc.).\r\n            \r\n### Example\r\n```\r\nGET /api/v1.1/commodities\r\n```","operationId":"getCommodities","parameters":[]}},"/api/v1.1/commodities/quotes/regular":{"get":{"tags":["Commodities"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CommodityQuote"}}}}}},"summary":"Latest quotes for \"regular\" actively-traded commodities.","description":"Refreshed continuously during market hours. Use this endpoint\r\nfor **trading screens** and **price tickers**.\r\n            \r\n### Example\r\n```\r\nGET /api/v1.1/commodities/quotes/regular\r\n```","operationId":"getCommoditiesQuotesRegular","parameters":[]}},"/api/v1.1/commodities/{commodityId}/quotes/regular/history":{"get":{"tags":["Commodities"],"parameters":[{"name":"commodityId","in":"path","required":true,"schema":{"type":"integer","format":"int32"},"description":"Commodity identifier (e.g., `1` for Brent)."},{"name":"from","in":"query","description":"Start date (`yyyy-MM-dd`). Default: yesterday.","schema":{"type":"string"},"example":"2024-01-01"},{"name":"to","in":"query","description":"End date (`yyyy-MM-dd`). Default: today.","schema":{"type":"string"},"example":"2024-03-31"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CommodityQuoteArchive"}}}}}},"summary":"Historical quotes for a \"regular\" commodity.","description":"Returns end-of-day archive prices for the supplied commodity\r\nacross the requested date window.\r\n            \r\n### Example\r\n```\r\nGET /api/v1.1/commodities/1/quotes/regular/history?from=2024-01-01&to=2024-01-31\r\n```","operationId":"getCommoditiesByCommodityIdQuotesRegularHistory"}},"/api/v1.1/commodities/{commodityId}/quotes/other/history":{"get":{"tags":["Commodities"],"parameters":[{"name":"commodityId","in":"path","required":true,"schema":{"type":"integer","format":"int32"},"description":"Numeric commodity identifier. Use `GET /api/v1.1/commodities` for valid values."},{"name":"from","in":"query","schema":{"type":"string"},"example":"2024-01-01","description":"Start of the date range, inclusive. Format `YYYY-MM-DD`."},{"name":"to","in":"query","schema":{"type":"string"},"example":"2024-03-31","description":"End of the date range, inclusive. Format `YYYY-MM-DD`."}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OtherCommodityQuote"}}}}}},"summary":"Get historical series for a commodity","description":"Returns the historical series for the commodity identified by `commodityId`.\n\nBound the result with the `from` and `to` date parameters.","operationId":"getCommoditiesByCommodityIdQuotesOtherHistory"}},"/api/v1.1/commodities/{commodityId}/shipping":{"get":{"tags":["Commodities"],"parameters":[{"name":"commodityId","in":"path","required":true,"schema":{"type":"integer","format":"int32"},"description":"Numeric commodity identifier. Use `GET /api/v1.1/commodities` for valid values."},{"name":"from","in":"query","schema":{"type":"string"},"example":"2024-01-01","description":"Start of the date range, inclusive. Format `YYYY-MM-DD`."},{"name":"to","in":"query","schema":{"type":"string"},"example":"2024-03-31","description":"End of the date range, inclusive. Format `YYYY-MM-DD`."}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ShippingPrice"}}}}}},"summary":"Shipping rates / freight prices for a commodity.","description":"Returns chartered / spot shipping prices. Useful for\r\nlanded-cost analysis when modeling regional trade flows.\r\n            \r\n### Example\r\n```\r\nGET /api/v1.1/commodities/1/shipping?from=2024-01-01&to=2024-01-31\r\n```","operationId":"getCommoditiesByCommodityIdShipping"}},"/api/v1.1/commodities/refining-margins":{"get":{"tags":["Commodities"],"parameters":[{"name":"from","in":"query","schema":{"type":"string"},"example":"2024-01-01","description":"Start of the date range, inclusive. Format `YYYY-MM-DD`."},{"name":"to","in":"query","schema":{"type":"string"},"example":"2024-03-31","description":"End of the date range, inclusive. Format `YYYY-MM-DD`."}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ShippingPrice"}}}}}},"summary":"List refining margins","description":"Returns the refining margins available on this layer.\n\nBound the result with the `from` and `to` date parameters.","operationId":"getCommoditiesRefiningMargins"}},"/api/v1.1/consumer-goods":{"get":{"tags":["ConsumerGoods"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{}}}}}},"summary":"Catalogue of all tracked consumer goods (materials).","description":"Returns the full taxonomy: material id, name (Ar/En),\r\ncategory (food, beverages, building, fuel, etc.), unit, and\r\nreference region.\r\n            \r\n### Example\r\n```\r\nGET /api/v1.1/consumer-goods\r\n```","operationId":"getConsumerGoods","parameters":[]}},"/api/v1.1/consumer-goods/prices":{"get":{"tags":["ConsumerGoods"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{}}}}}},"summary":"List prices","description":"Returns the prices available on this layer.","operationId":"getConsumerGoodsPrices","parameters":[]}},"/api/v1.1/consumer-goods/{materialId}/prices":{"get":{"tags":["ConsumerGoods"],"parameters":[{"name":"materialId","in":"path","required":true,"schema":{"type":"integer","format":"int32"},"description":"Material ID from `/`."}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{}}}}}},"summary":"Latest price for a specific material.","description":"Single-material variant of `/prices`. Returns the most\r\nrecent quote plus daily change.\r\n            \r\n### Example\r\n```\r\nGET /api/v1.1/consumer-goods/42/prices\r\n```","operationId":"getConsumerGoodsByMaterialIdPrices"}},"/api/v1.1/consumer-goods/{materialId}/prices/history":{"get":{"tags":["ConsumerGoods"],"parameters":[{"name":"materialId","in":"path","required":true,"schema":{"type":"integer","format":"int32"},"description":"Material ID."},{"name":"from","in":"query","description":"Start date (`yyyy-MM-dd`). Defaults to yesterday.","schema":{"type":"string"},"example":"2024-01-01"},{"name":"to","in":"query","description":"End date (`yyyy-MM-dd`). Defaults to today.","schema":{"type":"string"},"example":"2024-03-31"}],"responses":{"200":{"description":"Material name and a list of date/price observations for the requested window.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsumerGoodPriceHistoryResponse"},"example":{"materialID":11,"materialNameAr":"دقيق قمح (1 كجم)","materialNameEn":"Wheat Flour (1 kg)","prices":[{"forDate":"2023-01-01","price":3},{"forDate":"2023-04-01","price":3.1},{"forDate":"2023-07-01","price":3.2},{"forDate":"2023-10-01","price":3.25},{"forDate":"2024-01-01","price":3.25}]}}}}},"summary":"Historical prices for a specific material.","description":"Time series for trend analysis. Returns end-of-day archive\r\nprices over the requested window.\r\n            \r\n### Example\r\n```\r\nGET /api/v1.1/consumer-goods/42/prices/history?from=2023-01-01&to=2023-12-31\r\n```","operationId":"getConsumerGoodsByMaterialIdPricesHistory"}},"/api/v1.1/indicators/groups":{"get":{"tags":["Indicators"],"responses":{"200":{"description":"Success"}},"summary":"List all indicator groups.","description":"Returns the catalogue of groups (e.g., Saudi GDP, UAE\r\ninflation, GCC monetary aggregates). Each entry includes\r\nid, name (Ar/En), country, frequency, and field count.\r\n            \r\n### Example\r\n```\r\nGET /api/v1.1/indicators/groups\r\n```","operationId":"getIndicatorsGroups","parameters":[]}},"/api/v1.1/indicators/groups/{groupId}/fields":{"get":{"tags":["Indicators"],"parameters":[{"name":"groupId","in":"path","required":true,"schema":{"type":"integer","format":"int32"},"description":"Economic indicator group identifier."}],"responses":{"200":{"description":"Success"}},"summary":"Get fields for a group","description":"Returns the fields for the group identified by `groupId`.","operationId":"getIndicatorsGroupsByGroupIdFields"}},"/api/v1.1/indicators/groups/{groupId}/fields/{fieldId}/values":{"get":{"tags":["Indicators"],"parameters":[{"name":"groupId","in":"path","required":true,"schema":{"type":"integer","format":"int32"},"description":"Economic indicator group identifier."},{"name":"fieldId","in":"path","required":true,"schema":{"type":"integer","format":"int32"},"description":"Identifier of a field inside the selected indicator group."},{"name":"year","in":"query","schema":{"type":"integer","format":"int32","default":0},"example":2023,"description":"Calendar year to filter by, e.g. `2025`. Defaults to `0`."},{"name":"period","in":"query","schema":{"type":"string","default":"year"},"example":"year","description":"Time window for the series, e.g. `1d`, `1m`, `3m`, `1y`, `5y`. Defaults to `year`."},{"name":"fiscalPeriod","in":"query","schema":{"type":"string","default":""},"example":"year","description":"Fiscal period within the year: `1`-`4` for quarters, `5` for the full year."}],"responses":{"200":{"description":"Success"}},"summary":"Get an economic indicator series","description":"Returns the observation series for a single indicator field within a group - the actual macroeconomic time series.","operationId":"getIndicatorsGroupsByGroupIdFieldsByFieldIdValues"}},"/api/v1.1/markets/{marketId}/indicators":{"get":{"tags":["Markets"],"parameters":[{"name":"marketId","in":"path","required":true,"schema":{"type":"integer","format":"int32"},"description":"Market ID (e.g. `1` for Saudi Tadawul).","example":3}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiV1Response"}}}}},"summary":"Get key market indicators for a market (TASI, NOMU, breadth metrics).","description":"Returns the primary market indicators for the specified exchange:\r\nindex level (e.g. TASI for Tadawul, NOMU for the parallel market),\r\nmarket breadth (advancing / declining / unchanged), and volume metrics.\r\n            \r\n**Tip:** For a full market data record (OHLCV + change) use\r\n`GET /markets/{marketId}/data`. For sector-level breakdowns use\r\n`GET /markets/{marketId}/sectors`.","operationId":"getMarketsByMarketIdIndicators"}},"/api/v1.1/petrochemicals/index":{"get":{"tags":["Petrochemicals"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PetrochemicalPriceIndex"}}}}},"summary":"Latest value of the Argaam Petrochemical Price Index.","description":"Returns the current index level plus daily / weekly / monthly\r\nchanges. Drop into a header ticker on a sector dashboard.\r\n            \r\n### Example\r\n```\r\nGET /api/v1.1/petrochemicals/index\r\n```","operationId":"getPetrochemicalsIndex","parameters":[]}},"/api/v1.1/petrochemicals/index/history":{"get":{"tags":["Petrochemicals"],"parameters":[{"name":"from","in":"query","description":"Start date (`yyyy-MM-dd`).","schema":{"type":"string"},"example":"2024-01-01"},{"name":"to","in":"query","description":"End date (`yyyy-MM-dd`).","schema":{"type":"string"},"example":"2024-03-31"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PetrochemicalPriceIndex"}}}}}},"summary":"Historical values of the Argaam Petrochemical Price Index.","description":"Daily index history for the supplied window. Use for trend\r\ncharts and rolling-window analytics.\r\n            \r\n### Example\r\n```\r\nGET /api/v1.1/petrochemicals/index/history?from=2023-01-01&to=2023-12-31\r\n```","operationId":"getPetrochemicalsIndexHistory"}},"/api/v1.1/petrochemicals/products":{"get":{"tags":["Petrochemicals"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PetrochemicalProduct"}}}}}},"summary":"List products","description":"Returns the products available on this layer.","operationId":"getPetrochemicalsProducts","parameters":[]}},"/api/v1.1/petrochemicals/products/{productId}/prices":{"get":{"tags":["Petrochemicals"],"parameters":[{"name":"productId","in":"path","required":true,"schema":{"type":"integer","format":"int32"},"description":"Product ID from `/products`."},{"name":"regionId","in":"query","description":"Region ID. Defaults to Asia (`1`).","schema":{"type":"integer","format":"int32"},"example":1},{"name":"period","in":"query","description":"Rolling window. Default: `1M`. Defaults to `1M`.","schema":{"type":"string","default":"1M"},"example":"year"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PetrochemicalsProductPrices"}}}}}},"summary":"Latest prices for a petrochemical product (rolling window).","description":"Returns prices observed during the requested rolling period\r\n(`1D`, `1W`, `1M`, `3M`, `1Y`, `MAX`).\r\n            \r\n### Example\r\n```\r\nGET /api/v1.1/petrochemicals/products/12/prices?regionId=1&period=1M\r\n```","operationId":"getPetrochemicalsProductsByProductIdPrices"}},"/api/v1.1/petrochemicals/products/{productId}/prices/history":{"get":{"tags":["Petrochemicals"],"parameters":[{"name":"productId","in":"path","required":true,"schema":{"type":"integer","format":"int32"},"description":"Numeric petrochemical product identifier."},{"name":"regionId","in":"query","schema":{"type":"integer","format":"int32"},"example":1,"description":"Numeric region identifier."},{"name":"from","in":"query","schema":{"type":"string"},"example":"2024-01-01","description":"Start of the date range, inclusive. Format `YYYY-MM-DD`."},{"name":"to","in":"query","schema":{"type":"string"},"example":"2024-03-31","description":"End of the date range, inclusive. Format `YYYY-MM-DD`."}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PetrochemicalsProductPrices"}}}}}},"summary":"Historical prices for a petrochemical product (custom date range).","description":"Like `/products/{id}/prices` but takes an explicit\r\n`from`/`to` window for arbitrary historical analysis.\r\n            \r\n### Example\r\n```\r\nGET /api/v1.1/petrochemicals/products/12/prices/history?regionId=1&from=2023-01-01&to=2023-12-31\r\n```","operationId":"getPetrochemicalsProductsByProductIdPricesHistory"}},"/api/v1.1/petrochemicals/rig-counts":{"get":{"tags":["Petrochemicals"],"parameters":[{"name":"regionId","in":"query","description":"Region ID.","schema":{"type":"integer","format":"int32"},"example":1},{"name":"asOf","in":"query","description":"As-of date (`yyyy-MM-dd`).","schema":{"type":"string"},"example":"2024-01-15"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RigCount"}}}}}},"summary":"Active rig counts for a region as of a date.","description":"Rig counts are a classic **leading indicator** for upstream\r\noil & gas activity, and a useful sentiment proxy for\r\nmid-stream and downstream sectors.\r\n            \r\n### Example\r\n```\r\nGET /api/v1.1/petrochemicals/rig-counts?regionId=4&asOf=2024-01-15\r\n```","operationId":"getPetrochemicalsRigCounts"}}},"components":{"schemas":{"Commodity":{"type":"object","properties":{"commodityID":{"type":"integer","format":"int32"},"nameEn":{"type":"string","nullable":true},"nameAr":{"type":"string","nullable":true},"type":{"type":"string","nullable":true}},"additionalProperties":false},"CommodityQuote":{"type":"object","properties":{"commodityID":{"type":"integer","format":"int32"},"tickerChartCommodityName":{"type":"string","nullable":true},"commodityNameEn":{"type":"string","nullable":true},"commodityNameAr":{"type":"string","nullable":true},"forDate":{"type":"string","format":"date-time"},"openValue":{"type":"number","format":"double","nullable":true},"closeValue":{"type":"number","format":"double","nullable":true},"previousCloseValue":{"type":"number","format":"double","nullable":true},"high":{"type":"number","format":"double","nullable":true},"low":{"type":"number","format":"double","nullable":true},"indexValue":{"type":"number","format":"double","nullable":true},"change":{"type":"number","format":"double","nullable":true},"percentageChange":{"type":"number","format":"double","nullable":true},"ybgnChange":{"type":"number","format":"double","nullable":true},"month":{"type":"integer","format":"int32","nullable":true},"time":{"type":"string","format":"date-time","nullable":true},"lastUpdated":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false},"CommodityQuoteArchive":{"type":"object","properties":{"commodityID":{"type":"integer","format":"int32"},"commodityNameEn":{"type":"string","nullable":true},"commodityNameAr":{"type":"string","nullable":true},"forDate":{"type":"string","format":"date-time"},"openValue":{"type":"number","format":"double","nullable":true},"closeValue":{"type":"number","format":"double","nullable":true},"high":{"type":"number","format":"double","nullable":true},"low":{"type":"number","format":"double","nullable":true}},"additionalProperties":false},"OtherCommodityQuote":{"type":"object","properties":{"commodityID":{"type":"integer","format":"int32"},"commodityNameEn":{"type":"string","nullable":true},"commodityNameAr":{"type":"string","nullable":true},"regionNameAr":{"type":"string","nullable":true},"regionNameEn":{"type":"string","nullable":true},"forDate":{"type":"string","format":"date-time"},"averageValue":{"type":"number","format":"double","nullable":true},"high":{"type":"number","format":"double","nullable":true},"low":{"type":"number","format":"double","nullable":true}},"additionalProperties":false},"PetrochemicalPriceIndex":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"priceValue":{"type":"number","format":"double","nullable":true},"change":{"type":"number","format":"double","nullable":true}},"additionalProperties":false},"PetrochemicalProduct":{"type":"object","properties":{"productID":{"type":"integer","format":"int32"},"productNameAr":{"type":"string","nullable":true},"productNameEn":{"type":"string","nullable":true},"descriptionAr":{"type":"string","nullable":true},"descriptionEn":{"type":"string","nullable":true},"utilizationEn":{"type":"string","nullable":true},"utilizationAr":{"type":"string","nullable":true},"categoryID":{"type":"integer","format":"int32"},"attributeID":{"type":"integer","format":"int32","nullable":true},"isPublic":{"type":"boolean"},"isChartEnabledForReport":{"type":"boolean","nullable":true},"regionID":{"type":"integer","format":"int32"},"regionNameAr":{"type":"string","nullable":true},"regionNameEn":{"type":"string","nullable":true},"productPrice":{"type":"number","format":"double"},"changeInPrice":{"type":"number","format":"double","nullable":true},"entryDate":{"type":"string","format":"date-time"}},"additionalProperties":false},"PetrochemicalsProductPrices":{"type":"object","properties":{"productPriceID":{"type":"integer","format":"int32"},"regionID":{"type":"integer","format":"int32"},"categoryID":{"type":"integer","format":"int32"},"productID":{"type":"integer","format":"int32"},"productPrice":{"type":"number","format":"double"},"measuringUnitID":{"type":"integer","format":"int32"},"currencyID":{"type":"integer","format":"int32"},"entryDate":{"type":"string","format":"date-time"},"changeInPrice":{"type":"number","format":"double","nullable":true},"regionNameAr":{"type":"string","nullable":true},"regionNameEn":{"type":"string","nullable":true},"categoryNameAr":{"type":"string","nullable":true},"categoryNameEn":{"type":"string","nullable":true},"productNameAr":{"type":"string","nullable":true},"productNameEn":{"type":"string","nullable":true},"change":{"type":"number","format":"double","nullable":true}},"additionalProperties":false},"RigCount":{"type":"object","properties":{"rigCountID":{"type":"integer","format":"int32"},"forDate":{"type":"string","format":"date-time"},"oilRigCount":{"type":"number","format":"double","nullable":true},"regionID":{"type":"integer","format":"int32","nullable":true},"gasRigCount":{"type":"number","format":"double","nullable":true},"misc":{"type":"number","format":"double","nullable":true},"total":{"type":"number","format":"double","nullable":true},"dataFor":{"type":"string","nullable":true},"regionNameAr":{"type":"string","nullable":true},"regionNameEn":{"type":"string","nullable":true},"announceDate":{"type":"string","format":"date-time"},"close":{"type":"number","format":"double","nullable":true}},"additionalProperties":false},"ShippingPrice":{"type":"object","properties":{"commodityID":{"type":"integer","format":"int32"},"commodityNameEn":{"type":"string","nullable":true},"commodityNameAr":{"type":"string","nullable":true},"forDate":{"type":"string","format":"date-time"},"price":{"type":"number","format":"double","nullable":true}},"additionalProperties":false},"ConsumerGoodPriceHistoryResponse":{"type":"object","properties":{"materialID":{"type":"integer","format":"int32"},"materialNameAr":{"type":"string","nullable":true},"materialNameEn":{"type":"string","nullable":true},"prices":{"type":"array","items":{"$ref":"#/components/schemas/ConsumerGoodPriceEntry"},"nullable":true}},"additionalProperties":false,"description":"Price history for a single material."},"ConsumerGoodPriceEntry":{"type":"object","properties":{"forDate":{"type":"string","description":"Observation date (`yyyy-MM-dd`).","nullable":true},"price":{"type":"number","format":"double"}},"additionalProperties":false,"description":"A single date-price observation in a history series."},"ApiV1Response":{"type":"object","properties":{"success":{"type":"boolean","description":"Always true for successful responses."},"apiVersion":{"type":"string","description":"Semantic API version (e.g., \"1.0.0\").","nullable":true},"timestamp":{"type":"string","description":"UTC timestamp when the response was generated.","format":"date-time"},"requestId":{"type":"string","description":"Unique request identifier for tracing.","nullable":true},"data":{"description":"The response payload.","nullable":true},"meta":{"$ref":"#/components/schemas/ApiV1Meta"},"rateLimit":{"$ref":"#/components/schemas/ApiV1RateLimit"}},"additionalProperties":false,"description":"Standardized successful API response wrapper for v1.0.0 endpoints."},"ApiV1RateLimit":{"type":"object","properties":{"limit":{"type":"integer","description":"Total request quota for the current window.","format":"int32"},"remaining":{"type":"integer","description":"Remaining requests in the current window.","format":"int32"},"reset":{"type":"string","description":"UTC timestamp when the rate limit window resets.","format":"date-time"}},"additionalProperties":false,"description":"Rate limit information returned with each response."},"ApiV1Meta":{"type":"object","properties":{"page":{"type":"integer","description":"Current page number (1-based).","format":"int32"},"pageSize":{"type":"integer","description":"Number of items per page.","format":"int32"},"totalRecords":{"type":"integer","description":"Total number of records available across all pages.","format":"int32"},"totalPages":{"type":"integer","description":"Total number of pages.","format":"int32","readOnly":true},"hasNextPage":{"type":"boolean","description":"Whether there is a next page available.","readOnly":true},"hasPreviousPage":{"type":"boolean","description":"Whether there is a previous page available.","readOnly":true}},"additionalProperties":false,"description":"Pagination and metadata information for collection responses."}},"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"apikey"},"ApiKeyAuthQuery":{"type":"apiKey","in":"query","name":"apikey"}}},"security":[{"ApiKeyAuth":[]}],"servers":[{"url":"https://api-sandbox.argaam.com","description":"Argaam API Gateway (Sandbox)"}]}
````