---
title: "Full English style guide"
method: GET
path: "/api/v1/style-guide"
tags: ["Style Guide"]
---

# Full English style guide

`GET /api/v1/style-guide`

## Request

- Base URL: `https://glossary.ethereum.org`
- URL: `https://glossary.ethereum.org/api/v1/style-guide`
- Auth: none declared
- TypeScript: <https://skmtc.dev/ethereum/apis/ethglossary-api/docs/api/v1/style-guide/get.ts> (a function with typed inputs; its response is checked against the schema)

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

## Query parameters

- `category` string: Filter by category (comma-separated)

## Response `200`

Style guide terms

- StyleGuideList
  - `termCount` number, required
  - `terms` StyleGuideTerm[], required
    - `id` string, required
    - `term` string, required
    - `category` string, 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
    - `definition` string, required
    - `references` object[]: Further reading for this term. Present only when the term has any; `definition` never contains markup links.
      - `label` string, required
      - `url` string, required
    - `avoid` string[]
    - `aliases` object[]
      - `term` string, required
      - `status` 'preferred' | 'accepted', required
      - `note` string
    - `note` string
    - `scriptRule` string, required
    - `hasTooltip` boolean, required

---

[API](https://skmtc.dev/ethereum/apis/ethglossary-api.md) - [All operations](https://skmtc.dev/ethereum/apis/ethglossary-api/llms.txt) - [OpenAPI document](https://skmtc.dev/ethereum/apis/ethglossary-api/revisions/d0c021bf71fd?raw)