--- title: "Knowledge Base" description: "Understand identifiers, display names, fiscal periods, metrics, filters, and the mapping relationships required to integrate Argaam APIs correctly." url: "https://developer.argaam.com/knowledgebase" image: "https://developer.argaam.com/_og/d/c_Ocean.takumi,title_Knowledge+Base,description_~VW5kZXJzdGFuZCBpZGVudGlmaWVycywgZGlzcGxheSBuYW1lcywgZmlzY2FsIHBlcmlvZHMsIG1ldHJpY3MsIGZpbHRlcnMsIGFuZCB0aGUgbWFwcGluZyByZWxhdGlvbnNoaXBzIHJlcXVpcmVkIHRvIGludGVncmF0ZSBBcmdhYW0gQVBJcyBjb3JyZWN0bHku,props_eyJ0aGVtZSI6eyJtb2RlIjoibGlnaHQiLCJjb2xvcnMiOnsicHJpbWFyeSI6IiNGNTgwMjYifX19,p_Ii9rbm93bGVkZ2ViYXNlIg,s_20aK6AggOKv5OZwE.png" --- Knowledge Base [OverviewHome](#overview)[Parameter dictionary](#dictionary)[Relationship model](#relationships)[Parameter types](#types)[Mapping library](#library)[How to use a mapping](#howto) Reference data [MarketsLive](#library)[Companies & SymbolsLive](#library)[Fiscal PeriodsLive](#library)[Metrics & Financial FieldsLive](#library)[Languages & GeographiesLive](#library) ARGAAM DATA KNOWLEDGE BASE # Understand the data behind every API parameter. The identifiers, periods, metrics and mappings behind every parameter. [View parameter dictionary →](#dictionary)[Open API catalog](https://developer.argaam.com/catalog) From identifier to meaning. Tables pending 01Identify the parameter 02Resolve the mapping 03Use the exact request value 04Validate the response **Market mappings** IDs, names, and symbols **Entity mappings** Companies, funds, and records **Fiscal mappings** Periods, types, and years **Metric mappings** Fields, ratios, and indicators HOW THIS KNOWLEDGE BASE HELPS ## [Translate technical parameters into business meaning.](#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](#discover-valid-values) Find the ID, symbol, type, or metric value accepted by the selected API operation. ### [Understand relationships](#understand-relationships) See how markets, sectors, companies, periods, fields, and metrics relate to one another. ### [Build consistent mappings](#build-consistent-mappings) Use the same reference values across integrations, interfaces, reports, and internal data models. CORE PARAMETER DICTIONARY ## [Common identifiers and parameters across the API catalog.](#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 | ⚠ **Parameter names and casing must be copied exactly.** The catalog contains variations such as marketId and marketID, companyId and companyID, or lang and languageID. Treat the operation documentation as the source of truth for each request and response. RELATIONSHIP MODEL ## [Understand how the main identifiers connect.](#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. `MarketID` Identifies the market scope. `MarketName / MarketSymbol` Provides the market label or symbol. `SectorID` Identifies a sector or classification. `CompanyID` Identifies the company entity. `CompanyName / StockSymbol` Provides display and market-facing values. `FiscalPeriodTypeID` Identifies the reporting-period category. `FiscalPeriodID` Identifies the specific reporting period. `FiscalYear` Defines the reporting year. `FSFieldID / Metric` Selects a financial field or calculated measure. `Value` Returns 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. REQUEST PARAMETER TYPES ## [Recognize how parameters are used in API requests.](#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. **Identifiers** Select a market, company, fund, project, deal, article, field, or other record. `marketId · companyId · fundId · fieldId` **Filters** Narrow a result by category, type, sector, region, language, or other conditions. `type · category · sectorId · regionId · lang` **Dates and periods** Control reporting periods, historical ranges, and as-of-date requests. `from · to · asOf · year · fiscalPeriod` **Search and selection** Provide a search phrase, symbol, metric, or configurable field. `q · searchText · symbol · metric · fsFieldId` **Pagination and volume** Control the requested page and the number of records returned. `page · pageSize · records · companyCount` MAPPING LIBRARY ## [Reference tables that will be added to this knowledge base.](#reference-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. **Markets**Available Map markets, names, symbols, countries, and related market attributes. `MarketID · MarketName · MarketSymbol · CountryID` **Companies & Symbols**Available Map companies to names, stock symbols, markets, sectors, and entity identifiers. `CompanyID · CompanyName · StockSymbol · SectorID` **Fiscal Periods**Available Define reporting periods, period types, period values, and related years. `FiscalPeriodID · FiscalPeriodTypeID · FiscalYear` **Metrics & Financial Fields**Available Map supported metrics, statement fields, ratio fields, indicators, and units. `Metric · FSFieldID · FieldID · MeasuringUnitID` **Sectors & Classifications**Available Document sector identifiers and the relevant Argaam, market, or classification taxonomy. `SectorID · SectorName · Classification` **Languages & Geographies**Available Map languages, countries, regions, and bilingual display fields. `LanguageID · CountryID · RegionID · NameAr · NameEn` HOW TO USE A MAPPING ## [Resolve values before sending the request.](#resolve-values-before-sending-the-request) Follow the same workflow whenever an operation requires an identifier, type, metric, field, or controlled value. 01 **Open the API operation** Identify the exact path and query parameters required by the operation. 02 **Find the mapping category** Open the market, company, fiscal, metric, sector, or domain-specific reference. 03 **Select the approved value** Copy the identifier, symbol, type, or metric exactly as published. 04 **Validate the response** Confirm that returned names and identifiers match the selected mapping. ## [Mapping tables will be added as the reference data becomes available.](#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. [Browse API catalog →](https://developer.argaam.com/catalog)[Contact support](mailto:sales@argaam.com)