ETethereum
Style Guide

Look up a single term

Intelligent matching: resolves aliases, avoid forms, and morphological variants.

get/api/v1/style-guide/{termId}

Request

Path parameters

termIdstring required

Term ID, alias, or variant (intelligent matching)

Example:staking

Response

The style guide entry

idstring required
termstring required
categorystring required
termRole'concept' | 'brand-or-project' | 'person-name' | 'programming-language' | 'os-platform' | 'cryptographic-primitive' | 'network-name' | 'file-extension' | 'cli-command' | 'ticker-or-standard' | 'identifier'

v1 policy term role (informs default script_rule). Optional; see docs/translation-policy.md section 4.

casing'standard' | 'proper' | 'uppercase' | 'fixed' required
definitionstring required
avoidstring[]
notestring
scriptRulestring required
hasTooltipboolean required

Example response

{
  "id": "onchain",
  "term": "onchain",
  "category": "general",
  "termRole": "ticker-or-standard",
  "casing": "standard",
  "definition": "Refers to actions or data that exist on the blockchain.",
  "references": [
    {
      "label": "Gas and fees",
      "url": "https://ethereum.org/gas/"
    }
  ],
  "avoid": [
    "on chain",
    "on-chain",
    "On Chain"
  ],
  "note": "Always one word, no hyphen, lowercase unless starting a sentence.",
  "scriptRule": "translate",
  "hasTooltip": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.