IDs, names, and symbols
Companies, funds, and records
Periods, types, and years
Fields, ratios, and indicators
Translate technical parameters into business meaning.
The API catalog explains operations and request structures. This page complements it by documenting the controlled values and relationships used across Argaam data.
Discover valid values
Find the ID, symbol, type, or metric value accepted by the selected API operation.
Understand relationships
See how markets, sectors, companies, periods, fields, and metrics relate to one another.
Build consistent mappings
Use the same reference values across integrations, interfaces, reports, and internal data models.
Common identifiers and parameters across the API catalog.
This initial dictionary explains the purpose of frequently used fields. The exact mapping values will be added when the source tables are provided.
| Parameter | Meaning | How to use it | Reference |
|---|---|---|---|
MarketID / marketId | Numeric market identifier used to scope market-level data. | Resolve through the Markets mapping table. | Market mapping |
MarketName | Human-readable market label returned for display and interpretation. | Pair with the corresponding market identifier. | Market mapping |
CompanyID / companyId | Numeric identifier for a company or listed entity. | Resolve through the Companies mapping table. | Company mapping |
CompanyName | Human-readable company name, sometimes provided in Arabic and English variants. | Use for display; retain the identifier for request logic. | Company mapping |
StockSymbol / symbol | Market-facing company symbol used by company-level operations. | Copy the value exactly as published for the selected market. | Company mapping |
FiscalPeriodID | Identifier for a financial reporting period record. | Resolve through the Fiscal Periods mapping table. | Fiscal mapping |
FiscalPeriodTypeID | Identifier for the reporting-period category. | Use the mapping table to understand permitted values. | Fiscal mapping |
FiscalYear / year | Reporting or calendar year used to filter time-based data. | Follow the operation schema for accepted value and format. | Reference |
Metric | Metric or ranking key used to select a calculated measure. | Use only supported values published in the Metrics table. | Metric mapping |
FSFieldID / fieldId | Identifier for a financial statement, ratio, indicator, or configurable field. | Resolve the identifier before requesting field-level data. | Field mapping |
SectorID / sectorId | Identifier for a sector or classification group. | Resolve through the relevant sector taxonomy. | Sector mapping |
LanguageID / lang | Language selector used by operations with multilingual output. | Use the language mapping and exact value required by the operation. | Language mapping |
Understand how the main identifiers connect.
These flows are conceptual guides for interpreting the data. The final mapping tables will define the exact values and available relationships.
MarketIDIdentifies the market scope.
MarketName / MarketSymbolProvides the market label or symbol.
SectorIDIdentifies a sector or classification.
CompanyIDIdentifies the company entity.
CompanyName / StockSymbolProvides display and market-facing values.
FiscalPeriodTypeIDIdentifies the reporting-period category.
FiscalPeriodIDIdentifies the specific reporting period.
FiscalYearDefines the reporting year.
FSFieldID / MetricSelects a financial field or calculated measure.
ValueReturns the requested observation or result.
Use these diagrams for orientation only; they do not represent a physical database schema or guarantee that every operation supports every relationship.
Recognize how parameters are used in API requests.
Parameters may identify a resource, control a filter, define a time range, or manage the amount of data returned.
Select a market, company, fund, project, deal, article, field, or other record.
marketId · companyId · fundId · fieldIdNarrow a result by category, type, sector, region, language, or other conditions.
type · category · sectorId · regionId · langControl reporting periods, historical ranges, and as-of-date requests.
from · to · asOf · year · fiscalPeriodProvide a search phrase, symbol, metric, or configurable field.
q · searchText · symbol · metric · fsFieldIdControl the requested page and the number of records returned.
page · pageSize · records · companyCountReference tables that will be added to this knowledge base.
The structure is ready. Each card will be updated with searchable mapping tables when the underlying data is supplied.
Map markets, names, symbols, countries, and related market attributes.
MarketID · MarketName · MarketSymbol · CountryID
Map companies to names, stock symbols, markets, sectors, and entity identifiers.
CompanyID · CompanyName · StockSymbol · SectorID
Define reporting periods, period types, period values, and related years.
FiscalPeriodID · FiscalPeriodTypeID · FiscalYear
Map supported metrics, statement fields, ratio fields, indicators, and units.
Metric · FSFieldID · FieldID · MeasuringUnitID
Document sector identifiers and the relevant Argaam, market, or classification taxonomy.
SectorID · SectorName · Classification
Map languages, countries, regions, and bilingual display fields.
LanguageID · CountryID · RegionID · NameAr · NameEn
Resolve values before sending the request.
Follow the same workflow whenever an operation requires an identifier, type, metric, field, or controlled value.
Identify the exact path and query parameters required by the operation.
Open the market, company, fiscal, metric, sector, or domain-specific reference.
Copy the identifier, symbol, type, or metric exactly as published.
Confirm that returned names and identifiers match the selected mapping.
Mapping tables will be added as the reference data becomes available.
This page already provides the structure and parameter guidance. The market, company, fiscal-period, metric, and other mapping tables can be inserted without redesigning the page.