Style Guide

Full English style guide

All terms with canonical forms, casing rules, avoid lists, and usage notes.

get/api/v1/style-guide

Request

Query parameters

categorystring

Filter by category (comma-separated)

Example:defi,scaling

Response

Style guide terms

termCountnumber required

Example response

{
  "termCount": 486,
  "terms": [
    {
      "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.