Filter

Filter glossary terms for source content

Send source text and get back the glossary terms relevant to that content. Strips code blocks, inline code, and URLs before matching. Max 1MB content size.

post/api/v1/filter

Request

Base URL
https://glossary.ethereum.org
Auth
none declared
TypeScript
https://skmtc.dev/ethereum/apis/ethglossary-api/docs/api/v1/filter/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

contentstring required

Source text to filter against (max 1MB)

languagestring required

Target language code

fileType'markdown' | 'json'

Source content type (affects text extraction)

includeExamplesboolean

Include example sentences for high-frequency terms (2+ occurrences)

Example request

{
  "content": "Staking is the act of depositing 32 ETH to activate validator software...",
  "language": "es",
  "fileType": "markdown"
}

Response

Matching glossary terms

languagestring required

matchedTermsnumber required

totalScannednumber required

Example response

{
  "language": "es",
  "matchedTerms": 5,
  "totalScanned": 486,
  "terms": [
    {
      "english": "staking",
      "translation": "staking",
      "occurrences": 3
    }
  ]
}

Changes

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