Documentation

Market translations introduction¶

• Domain Model documentation
• Translation schema documents (condition format and translation format)
  • Response with translations schema contains four entities that are used in localization of markets:
    • markets
    • outcomes
    • periods
    • trading types
  • Each entity is a map of entity id to an array of entity translations. All entities (except trading types) have complex rules for translation. These rules are compactly encoded in condition property. Client code should check every condition in array and first matching should be used for translation.

Translation Schema Structure¶

The translation functions expect translation schema from API endpoint /v0/sport/feed/localization/markets. Key structure includes:

Structure and content are described in condition format and translation format docs.

JS snippets for Frontend implementation¶

This section targets clients who will use JavaScript snippets from the examples folder. Note: these snippets are frontend implementation details built based on:

Download examples.zip: - Archive with all js snippets and usage demo.

Market Object Schema¶

The market translation functions work with market objects that follow the MarketDto API schema (Similar for LineApi and DFAPI):

{
  "key": {
    "period": 0,           // Period of market (integer)
    "subPeriod": null,     // Sub-period of market (integer, nullable)
    "marketType": 1,       // Type of market (integer)
    "resultKind": 1,       // Kind of market (integer)
    "layout": null         // Layout string (nullable, deprecated)
  },
  "items": [
    {
      "values": [],        // Market specific array of values (e.g. ["3", "1"])
      "isOpen": true,      // Shows that market is open for trading
      "outcomes": [
        {
          "key": {
            "type": 0,       // Outcome type (integer)
            "values": []     // Outcome values array
          },
          "odd": 230,        // Odd multiplied by 100 (e.g. 1.35 = 135)
          "status": "Opened" // Status: "Opened", "Suspended", "Removed"
        }
      ]
    }
  ],
  "tabs": [0]              // Array of tab integers
}

Related Schema Objects¶

Exported Functions Documentation¶

getMarketName()¶

Location: marketName.js

Purpose: Generates translated market names based on market data and translation rules.

Parameter Specifications:

Returns: String - Translated market name

getMarketItemName()¶

Location: marketName.js

Purpose: Generates translated market item names for specific market items.

Parameter Specifications:

Returns: String - Translated market item name

getOutcomeName()¶

Location: OutcomeName.utils.js

Purpose: Generates translated outcome names for individual outcomes within market items.

Parameter Specifications:

Returns: String - Translated outcome name

Function Parameters Details¶

Common Parameters¶

Market Object Field Mappings:

• marketId maps directly to market.key from MarketDto
• marketParameters maps to market.items[0].values from first MarketItemDto (works with markets with single market item)
• outcomeKey maps directly to outcome.key from OutcomeDto