{ "openapi": "3.0.3", "info": { "title": "Unique Domains API: Word Intelligence", "version": "1.0.0", "description": "The one-word catalog: profiles, endings, names, trademarks, notability, market and the word intake." }, "servers": [ { "url": "https://api.unique.domains/v1" } ], "tags": [ { "name": "words", "description": "Word Intelligence: The one-word catalog: profiles, endings, names, trademarks, notability, market and the word intake." }, { "name": "shared", "description": "The `/meta` and `/editions` paths, in every listing." } ], "paths": { "/words/resolve": { "get": { "operationId": "resolve_word", "summary": "Turns what a caller typed into the catalog word it names, or up to five candidates.", "description": "Tries the spelling as typed, its lowercase, accents stripped, spaces and hyphens removed, one inflection suffix stripped, then the lookalike spelling. A miss answers 200 with `candidates` (words starting with the query), never 404. Words with a deny class are never a match nor a candidate.", "tags": [ "words" ], "parameters": [ { "name": "q", "in": "query", "required": true, "description": "What the caller typed, 1 to 255 characters.", "schema": { "type": "string" }, "example": "harbors" }, { "name": "fields", "in": "query", "required": false, "description": "Comma-separated top-level keys to keep: match, candidates.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Turns what a caller typed into the catalog word it names, or up to five candidates.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "meta", "links" ], "properties": { "data": { "type": "object", "properties": { "match": { "type": "object", "required": [ "id", "slug", "word", "shape", "origin" ], "properties": { "id": { "type": "string", "description": "`wrd_`." }, "slug": { "nullable": true, "type": "string" }, "word": { "type": "string" }, "shape": { "enum": [ "single", "properNoun", "acronym", "twoWords", "phrase", null ], "nullable": true, "type": "string" }, "origin": { "type": "string", "enum": [ "dictionary", "trend", "api", "review" ] }, "via": { "type": "string", "enum": [ "exact", "case", "accent", "inflected", "lookalike", "two_words" ] } } }, "candidates": { "type": "array", "items": { "type": "object", "required": [ "id", "slug", "word", "shape", "origin" ], "properties": { "id": { "type": "string", "description": "`wrd_`." }, "slug": { "nullable": true, "type": "string" }, "word": { "type": "string" }, "shape": { "enum": [ "single", "properNoun", "acronym", "twoWords", "phrase", null ], "nullable": true, "type": "string" }, "origin": { "type": "string", "enum": [ "dictionary", "trend", "api", "review" ] } } } } } }, "meta": { "$ref": "#/components/schemas/Meta" }, "links": { "$ref": "#/components/schemas/Links" } } }, "example": { "data": { "match": { "id": "wrd_48213", "slug": "harbor", "word": "harbor", "shape": "single", "origin": "dictionary", "via": "inflected" } } } } } }, "304": { "description": "Not modified (`If-None-Match`)." }, "400": { "$ref": "#/components/responses/Problem400" }, "401": { "$ref": "#/components/responses/Problem401" }, "403": { "$ref": "#/components/responses/Problem403" }, "404": { "$ref": "#/components/responses/Problem404" }, "422": { "$ref": "#/components/responses/Problem422" }, "429": { "$ref": "#/components/responses/Problem429" }, "500": { "$ref": "#/components/responses/Problem500" }, "503": { "$ref": "#/components/responses/Problem503" } }, "x-tier": "free", "x-rapidapi-host": "word-intelligence.p.rapidapi.com" } }, "/words/categories": { "get": { "operationId": "list_word_categories", "summary": "The catalog's word categories, by name.", "description": "The `category` filter values of `GET /words`. The catch-all `general` category is left out, as on the profile. The whole list, no cursor.", "tags": [ "words" ], "parameters": [ { "name": "fields", "in": "query", "required": false, "description": "Comma-separated top-level keys to keep: slug, name.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The catalog's word categories, by name.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "meta", "links" ], "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "slug", "name" ], "properties": { "slug": { "type": "string" }, "name": { "nullable": true, "type": "string" } } } }, "meta": { "$ref": "#/components/schemas/Meta" }, "links": { "$ref": "#/components/schemas/Links" } } }, "example": { "data": [ { "slug": "travel", "name": "Travel" } ] } } } }, "304": { "description": "Not modified (`If-None-Match`)." }, "400": { "$ref": "#/components/responses/Problem400" }, "401": { "$ref": "#/components/responses/Problem401" }, "403": { "$ref": "#/components/responses/Problem403" }, "404": { "$ref": "#/components/responses/Problem404" }, "422": { "$ref": "#/components/responses/Problem422" }, "429": { "$ref": "#/components/responses/Problem429" }, "500": { "$ref": "#/components/responses/Problem500" }, "503": { "$ref": "#/components/responses/Problem503" } }, "x-tier": "free", "x-rapidapi-host": "word-intelligence.p.rapidapi.com" } }, "/words/batch": { "post": { "operationId": "batch_words", "summary": "Up to 100 word profiles in one call.", "description": "One entry per key, in the request's order: the profile of `GET /words/{word}`, or `{ word, found: false }` for a key the catalog does not answer (unknown, disabled, or never shown). Billed one request per key sent, misses included.", "tags": [ "words" ], "parameters": [ { "name": "fields", "in": "query", "required": false, "description": "Comma-separated top-level keys to keep: id, word, slug, shape, pos, definition, inflected, size, popularity, sentiment, brandability, style, categories, denyClass, origin, addedAt, linguistics, found.", "schema": { "type": "string" } } ], "requestBody": { "required": true, "description": "1 to 100 keys, each a spelling, a slug or `wrd_`.", "content": { "application/json": { "schema": { "type": "object", "required": [ "words" ], "properties": { "words": { "type": "array", "items": { "type": "string" } } } }, "example": { "words": [ "harbor", "wrd_48214" ] } } } }, "responses": { "200": { "description": "Up to 100 word profiles in one call.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "meta", "links" ], "properties": { "data": { "type": "array", "items": { "oneOf": [ { "type": "object", "required": [ "id", "word", "origin", "categories", "linguistics" ], "properties": { "id": { "type": "string", "description": "`wrd_`." }, "word": { "type": "string" }, "slug": { "nullable": true, "type": "string" }, "shape": { "enum": [ "single", "properNoun", "acronym", "twoWords", "phrase", null ], "nullable": true, "type": "string" }, "pos": { "description": "Parts of speech as stored, comma-joined tags.", "nullable": true, "type": "string" }, "definition": { "nullable": true, "type": "string" }, "inflected": { "nullable": true, "type": "boolean" }, "size": { "nullable": true, "type": "integer" }, "popularity": { "minimum": 0, "maximum": 100, "description": "How widely the word is used; never sales or demand.", "nullable": true, "type": "integer" }, "sentiment": { "minimum": 0, "maximum": 100, "description": "50 is neutral.", "nullable": true, "type": "integer" }, "brandability": { "minimum": 0, "maximum": 100, "nullable": true, "type": "integer" }, "style": { "enum": [ "modern", "elegant", "slab", "handwritten", "playful", "futuristic", null ], "nullable": true, "type": "string" }, "categories": { "type": "array", "items": { "type": "object", "required": [ "slug", "name" ], "properties": { "slug": { "type": "string" }, "name": { "nullable": true, "type": "string" } } } }, "denyClass": { "enum": [ "brand", "trademark", "person", "harm", "vice", "politics", "controversy", null ], "description": "Why the word stays off public lists (ADR-0111); null when none.", "nullable": true, "type": "string" }, "origin": { "type": "string", "enum": [ "dictionary", "trend", "api", "review" ] }, "addedAt": { "format": "date-time", "description": "When the intake added it; null means the dictionary load.", "nullable": true, "type": "string" }, "linguistics": { "type": "object", "properties": { "lookalikeIsLookalike": { "nullable": true, "type": "boolean" }, "lookalikeNormalized": { "nullable": true, "type": "string" }, "memorabilityFamiliarity": { "nullable": true, "type": "integer" }, "memorabilityLabel": { "enum": [ "low", "medium", "high", null ], "nullable": true, "type": "string" }, "memorabilityNeighbors": { "nullable": true, "type": "integer" }, "memorabilityScore": { "nullable": true, "type": "integer" }, "pronounceabilityLabel": { "enum": [ "easy", "medium", "hard", null ], "nullable": true, "type": "string" }, "pronounceabilityPhonotactic": { "nullable": true, "type": "integer" }, "pronounceabilityScore": { "nullable": true, "type": "integer" }, "pronunciationArpabet": { "nullable": true, "type": "string" }, "pronunciationConfidence": { "enum": [ "low", "medium", "high", null ], "nullable": true, "type": "string" }, "pronunciationIpa": { "nullable": true, "type": "string" }, "pronunciationStressPattern": { "nullable": true, "type": "string" }, "pronunciationSyllables": { "nullable": true, "type": "integer" }, "soundTextureLabel": { "enum": [ "soft", "balanced", "sharp", null ], "nullable": true, "type": "string" }, "soundTextureSharpness": { "nullable": true, "type": "integer" }, "soundTextureSoftness": { "nullable": true, "type": "integer" }, "spellingHomophones": { "nullable": true, "type": "integer" }, "spellingLabel": { "enum": [ "low", "medium", "high", null ], "nullable": true, "type": "string" }, "spellingLikelyMisspellings": { "type": "array", "items": { "type": "string" } }, "spellingRisk": { "nullable": true, "type": "integer" }, "spellingSoundalikes": { "nullable": true, "type": "integer" } } } } }, { "type": "object", "required": [ "word", "found" ], "properties": { "word": { "type": "string" }, "found": { "type": "boolean", "description": "Always false on a miss." } } } ] } }, "meta": { "$ref": "#/components/schemas/Meta" }, "links": { "$ref": "#/components/schemas/Links" } } }, "example": { "data": [ { "id": "wrd_48213", "word": "harbor", "slug": "harbor", "shape": "single", "origin": "dictionary", "popularity": 71 }, { "word": "harborr", "found": false } ] } } } }, "400": { "$ref": "#/components/responses/Problem400" }, "401": { "$ref": "#/components/responses/Problem401" }, "403": { "$ref": "#/components/responses/Problem403" }, "404": { "$ref": "#/components/responses/Problem404" }, "422": { "$ref": "#/components/responses/Problem422" }, "429": { "$ref": "#/components/responses/Problem429" }, "500": { "$ref": "#/components/responses/Problem500" }, "503": { "$ref": "#/components/responses/Problem503" } }, "x-tier": "keyed", "x-plan": "investor", "x-rapidapi-host": "word-intelligence.p.rapidapi.com" } }, "/words": { "get": { "operationId": "list_words", "summary": "Searches the catalog's words by text and facets, alphabetically.", "description": "Enabled words only, every word with a deny class left out. Alphabetical order only, keyset-paged by `(word, id)`. Popularity and sentiment are numeric ranges on the stored 0 to 100 scale.", "tags": [ "words" ], "parameters": [ { "name": "q", "in": "query", "required": false, "description": "A prefix of the word.", "schema": { "type": "string" } }, { "name": "contains", "in": "query", "required": false, "description": "A substring of the word.", "schema": { "type": "string" } }, { "name": "pos", "in": "query", "required": false, "description": "A part-of-speech tag as stored (`noun`, `verb`, `adjective`, ...).", "schema": { "type": "string" } }, { "name": "shape", "in": "query", "required": false, "description": "The entry's shape. One of: single, properNoun, acronym, twoWords, phrase.", "schema": { "type": "string" } }, { "name": "minLength", "in": "query", "required": false, "description": "Shortest length.", "schema": { "type": "integer", "minimum": 1, "maximum": 63 } }, { "name": "maxLength", "in": "query", "required": false, "description": "Longest length.", "schema": { "type": "integer", "minimum": 1, "maximum": 63 } }, { "name": "popularityMin", "in": "query", "required": false, "description": "Lowest popularity (how widely the word is used).", "schema": { "type": "integer", "minimum": 0, "maximum": 100 } }, { "name": "popularityMax", "in": "query", "required": false, "description": "Highest popularity.", "schema": { "type": "integer", "minimum": 0, "maximum": 100 } }, { "name": "sentimentMin", "in": "query", "required": false, "description": "Lowest sentiment (50 is neutral).", "schema": { "type": "integer", "minimum": 0, "maximum": 100 } }, { "name": "sentimentMax", "in": "query", "required": false, "description": "Highest sentiment.", "schema": { "type": "integer", "minimum": 0, "maximum": 100 } }, { "name": "style", "in": "query", "required": false, "description": "The word's type style. One of: modern, elegant, slab, handwritten, playful, futuristic.", "schema": { "type": "string" } }, { "name": "syllables", "in": "query", "required": false, "description": "Syllable count.", "schema": { "type": "integer", "minimum": 1, "maximum": 20 } }, { "name": "origin", "in": "query", "required": false, "description": "How the word entered the catalog. One of: dictionary, trend, api, review.", "schema": { "type": "string" } }, { "name": "category", "in": "query", "required": false, "description": "A category slug (`GET /words/categories`).", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "Page size: at most 20 on the free tier, 100 on a paid subscription; a larger value is clamped. Default: 20.", "schema": { "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "cursor", "in": "query", "required": false, "description": "The `meta.cursor` of the previous page.", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "required": false, "description": "Comma-separated top-level keys to keep: id, slug, word, shape, pos, size, origin.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Searches the catalog's words by text and facets, alphabetically.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "meta", "links" ], "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "id", "slug", "word", "shape", "pos", "size", "origin" ], "properties": { "id": { "type": "string" }, "slug": { "nullable": true, "type": "string" }, "word": { "type": "string" }, "shape": { "enum": [ "single", "properNoun", "acronym", "twoWords", "phrase", null ], "nullable": true, "type": "string" }, "pos": { "nullable": true, "type": "string" }, "size": { "nullable": true, "type": "integer" }, "origin": { "type": "string", "enum": [ "dictionary", "trend", "api", "review" ] } } } }, "meta": { "$ref": "#/components/schemas/Meta" }, "links": { "$ref": "#/components/schemas/Links" } } }, "example": { "data": [ { "id": "wrd_48213", "slug": "harbor", "word": "harbor", "shape": "single", "pos": "noun,verb", "size": 6, "origin": "dictionary" } ] } }, "text/csv": { "schema": { "type": "string" } } } }, "304": { "description": "Not modified (`If-None-Match`)." }, "400": { "$ref": "#/components/responses/Problem400" }, "401": { "$ref": "#/components/responses/Problem401" }, "403": { "$ref": "#/components/responses/Problem403" }, "404": { "$ref": "#/components/responses/Problem404" }, "422": { "$ref": "#/components/responses/Problem422" }, "429": { "$ref": "#/components/responses/Problem429" }, "500": { "$ref": "#/components/responses/Problem500" }, "503": { "$ref": "#/components/responses/Problem503" } }, "x-tier": "keyed", "x-rapidapi-host": "word-intelligence.p.rapidapi.com" } }, "/words/{word}": { "get": { "operationId": "get_word", "summary": "A word's profile: definition, facets, categories, origin and linguistics.", "description": "Reads the catalog `Word` row and its categories. A word unknown, disabled, offensive or not a word answers 404 with up to five candidates.", "tags": [ "words" ], "parameters": [ { "name": "word", "in": "path", "required": true, "description": "The catalog slug, the word, or `wrd_`.", "schema": { "type": "string" }, "example": "harbor" }, { "name": "fields", "in": "query", "required": false, "description": "Comma-separated top-level keys to keep: id, word, slug, shape, pos, definition, inflected, size, popularity, sentiment, brandability, style, categories, denyClass, origin, addedAt, linguistics.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A word's profile: definition, facets, categories, origin and linguistics.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "meta", "links" ], "properties": { "data": { "type": "object", "required": [ "id", "word", "origin", "categories", "linguistics" ], "properties": { "id": { "type": "string", "description": "`wrd_`." }, "word": { "type": "string" }, "slug": { "nullable": true, "type": "string" }, "shape": { "enum": [ "single", "properNoun", "acronym", "twoWords", "phrase", null ], "nullable": true, "type": "string" }, "pos": { "description": "Parts of speech as stored, comma-joined tags.", "nullable": true, "type": "string" }, "definition": { "nullable": true, "type": "string" }, "inflected": { "nullable": true, "type": "boolean" }, "size": { "nullable": true, "type": "integer" }, "popularity": { "minimum": 0, "maximum": 100, "description": "How widely the word is used; never sales or demand.", "nullable": true, "type": "integer" }, "sentiment": { "minimum": 0, "maximum": 100, "description": "50 is neutral.", "nullable": true, "type": "integer" }, "brandability": { "minimum": 0, "maximum": 100, "nullable": true, "type": "integer" }, "style": { "enum": [ "modern", "elegant", "slab", "handwritten", "playful", "futuristic", null ], "nullable": true, "type": "string" }, "categories": { "type": "array", "items": { "type": "object", "required": [ "slug", "name" ], "properties": { "slug": { "type": "string" }, "name": { "nullable": true, "type": "string" } } } }, "denyClass": { "enum": [ "brand", "trademark", "person", "harm", "vice", "politics", "controversy", null ], "description": "Why the word stays off public lists (ADR-0111); null when none.", "nullable": true, "type": "string" }, "origin": { "type": "string", "enum": [ "dictionary", "trend", "api", "review" ] }, "addedAt": { "format": "date-time", "description": "When the intake added it; null means the dictionary load.", "nullable": true, "type": "string" }, "linguistics": { "type": "object", "properties": { "lookalikeIsLookalike": { "nullable": true, "type": "boolean" }, "lookalikeNormalized": { "nullable": true, "type": "string" }, "memorabilityFamiliarity": { "nullable": true, "type": "integer" }, "memorabilityLabel": { "enum": [ "low", "medium", "high", null ], "nullable": true, "type": "string" }, "memorabilityNeighbors": { "nullable": true, "type": "integer" }, "memorabilityScore": { "nullable": true, "type": "integer" }, "pronounceabilityLabel": { "enum": [ "easy", "medium", "hard", null ], "nullable": true, "type": "string" }, "pronounceabilityPhonotactic": { "nullable": true, "type": "integer" }, "pronounceabilityScore": { "nullable": true, "type": "integer" }, "pronunciationArpabet": { "nullable": true, "type": "string" }, "pronunciationConfidence": { "enum": [ "low", "medium", "high", null ], "nullable": true, "type": "string" }, "pronunciationIpa": { "nullable": true, "type": "string" }, "pronunciationStressPattern": { "nullable": true, "type": "string" }, "pronunciationSyllables": { "nullable": true, "type": "integer" }, "soundTextureLabel": { "enum": [ "soft", "balanced", "sharp", null ], "nullable": true, "type": "string" }, "soundTextureSharpness": { "nullable": true, "type": "integer" }, "soundTextureSoftness": { "nullable": true, "type": "integer" }, "spellingHomophones": { "nullable": true, "type": "integer" }, "spellingLabel": { "enum": [ "low", "medium", "high", null ], "nullable": true, "type": "string" }, "spellingLikelyMisspellings": { "type": "array", "items": { "type": "string" } }, "spellingRisk": { "nullable": true, "type": "integer" }, "spellingSoundalikes": { "nullable": true, "type": "integer" } } } } }, "meta": { "$ref": "#/components/schemas/Meta" }, "links": { "$ref": "#/components/schemas/Links" } } }, "example": { "data": { "id": "wrd_48213", "word": "harbor", "slug": "harbor", "shape": "single", "pos": "noun,verb", "definition": "A sheltered stretch of water where ships can moor.", "inflected": false, "size": 6, "popularity": 71, "sentiment": 58, "brandability": 74, "style": "elegant", "categories": [ { "slug": "travel", "name": "Travel" } ], "denyClass": null, "origin": "dictionary", "addedAt": null, "linguistics": { "pronunciationIpa": "ˈhɑɹbɚ", "pronunciationArpabet": "HH AA1 R B ER0", "pronunciationSyllables": 2, "pronunciationStressPattern": "10", "pronunciationConfidence": "high", "pronounceabilityLabel": "easy", "pronounceabilityScore": 88, "pronounceabilityPhonotactic": 81, "memorabilityLabel": "high", "memorabilityScore": 77, "memorabilityFamiliarity": 72, "memorabilityNeighbors": 9, "spellingLabel": "low", "spellingRisk": 22, "spellingHomophones": 0, "spellingSoundalikes": 2, "spellingLikelyMisspellings": [ "harbour", "harber" ], "soundTextureLabel": "soft", "soundTextureSoftness": 64, "soundTextureSharpness": 36, "lookalikeIsLookalike": false, "lookalikeNormalized": "harbor" } } } } } }, "304": { "description": "Not modified (`If-None-Match`)." }, "400": { "$ref": "#/components/responses/Problem400" }, "401": { "$ref": "#/components/responses/Problem401" }, "403": { "$ref": "#/components/responses/Problem403" }, "404": { "$ref": "#/components/responses/Problem404" }, "422": { "$ref": "#/components/responses/Problem422" }, "429": { "$ref": "#/components/responses/Problem429" }, "500": { "$ref": "#/components/responses/Problem500" }, "503": { "$ref": "#/components/responses/Problem503" } }, "x-tier": "keyed", "x-rapidapi-host": "word-intelligence.p.rapidapi.com" } }, "/words/{word}/endings": { "get": { "operationId": "get_word_endings", "summary": "A word's endings as the nightly update holds them: counts, the key endings and open names per ending.", "description": "Reads the `WordEndings` row. A word with no row yet answers zero counts. The cheapest ending is a keyed include only: a name chosen by price never reaches the free tier.", "tags": [ "words" ], "parameters": [ { "name": "word", "in": "path", "required": true, "description": "The catalog slug, the word, or `wrd_`.", "schema": { "type": "string" }, "example": "harbor" }, { "name": "fields", "in": "query", "required": false, "description": "Comma-separated top-level keys to keep: byGroup, keyEndings, openByEnding, cheapest.", "schema": { "type": "string" } }, { "name": "include", "in": "query", "required": false, "description": "Comma-separated optional blocks: cheapest (paid).", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A word's endings as the nightly update holds them: counts, the key endings and open names per ending.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "meta", "links" ], "properties": { "data": { "type": "object", "required": [ "byGroup", "keyEndings", "openByEnding" ], "properties": { "byGroup": { "type": "object", "properties": { "scanned": { "type": "integer" }, "taken": { "type": "integer" }, "available": { "type": "integer" }, "forSale": { "type": "integer" } } }, "keyEndings": { "type": "array", "items": { "type": "object", "properties": { "ending": { "type": "string" }, "status": { "nullable": true, "type": "string" }, "price": { "nullable": true, "type": "number" } } } }, "openByEnding": { "type": "object", "additionalProperties": { "type": "integer" }, "description": "`{ ending: count }`." }, "cheapest": { "type": "object", "description": "Keyed `include=cheapest` only.", "properties": { "ending": { "nullable": true, "type": "string" }, "price": { "nullable": true, "type": "number" } } } } }, "meta": { "$ref": "#/components/schemas/Meta" }, "links": { "$ref": "#/components/schemas/Links" } } }, "example": { "data": { "byGroup": { "scanned": 96, "taken": 71, "available": 18, "forSale": 7 }, "keyEndings": [ { "ending": "com", "status": "taken", "price": null }, { "ending": "io", "status": "available", "price": 34.98 } ], "openByEnding": { "io": 1, "co": 1, "studio": 1 } } } } } }, "304": { "description": "Not modified (`If-None-Match`)." }, "400": { "$ref": "#/components/responses/Problem400" }, "401": { "$ref": "#/components/responses/Problem401" }, "403": { "$ref": "#/components/responses/Problem403" }, "404": { "$ref": "#/components/responses/Problem404" }, "422": { "$ref": "#/components/responses/Problem422" }, "429": { "$ref": "#/components/responses/Problem429" }, "500": { "$ref": "#/components/responses/Problem500" }, "503": { "$ref": "#/components/responses/Problem503" } }, "x-tier": "free", "x-rapidapi-host": "word-intelligence.p.rapidapi.com" } }, "/words/{word}/names": { "get": { "operationId": "list_word_names", "summary": "A word's catalog names on the endings that sell, by name.", "description": "Catalog rows only (never a name a live check created), on the endings with a market, name order, keyset-paged by `(name, id)`.", "tags": [ "words" ], "parameters": [ { "name": "word", "in": "path", "required": true, "description": "The catalog slug, the word, or `wrd_`.", "schema": { "type": "string" }, "example": "harbor" }, { "name": "limit", "in": "query", "required": false, "description": "Page size: at most 20 on the free tier, 100 on a paid subscription; a larger value is clamped. Default: 20.", "schema": { "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "cursor", "in": "query", "required": false, "description": "The `meta.cursor` of the previous page.", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "required": false, "description": "Comma-separated top-level keys to keep: id, name, ending, status, price, renewal, registrar, expires, parking, lifecycle, dropsOn, created.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A word's catalog names on the endings that sell, by name.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "meta", "links" ], "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "`dom_`." }, "name": { "type": "string" }, "ending": { "type": "string" }, "status": { "type": "string" }, "price": { "nullable": true, "type": "number" }, "renewal": { "nullable": true, "type": "number" }, "registrar": { "nullable": true, "type": "string" }, "expires": { "format": "date-time", "nullable": true, "type": "string" }, "parking": { "nullable": true, "type": "string" }, "lifecycle": { "nullable": true, "type": "string" }, "dropsOn": { "format": "date", "nullable": true, "type": "string" }, "created": { "format": "date-time", "nullable": true, "type": "string" } } } }, "meta": { "$ref": "#/components/schemas/Meta" }, "links": { "$ref": "#/components/schemas/Links" } } }, "example": { "data": [ { "id": "dom_3f1c9a2e-5b7d-4c11-9a0e-2d6f8b4c7e10", "name": "harbor.io", "ending": "io", "status": "available", "price": 34.98, "renewal": 54.98, "registrar": null, "expires": null, "parking": null, "lifecycle": null, "dropsOn": null, "created": null } ] } }, "text/csv": { "schema": { "type": "string" } } } }, "304": { "description": "Not modified (`If-None-Match`)." }, "400": { "$ref": "#/components/responses/Problem400" }, "401": { "$ref": "#/components/responses/Problem401" }, "403": { "$ref": "#/components/responses/Problem403" }, "404": { "$ref": "#/components/responses/Problem404" }, "422": { "$ref": "#/components/responses/Problem422" }, "429": { "$ref": "#/components/responses/Problem429" }, "500": { "$ref": "#/components/responses/Problem500" }, "503": { "$ref": "#/components/responses/Problem503" } }, "x-tier": "keyed", "x-rapidapi-host": "word-intelligence.p.rapidapi.com" } }, "/words/{word}/trademarks": { "get": { "operationId": "get_word_trademarks", "summary": "A word's trademark counts and its exact-match marks.", "description": "Live US and EU trademark counts with their classes, and up to 50 exact-match trademarks (live first, newest filing first) before the `office` and `status` filters. Zero live trademarks means no exact match was found, never that a name is safe.", "tags": [ "words" ], "parameters": [ { "name": "word", "in": "path", "required": true, "description": "The catalog slug, the word, or `wrd_`.", "schema": { "type": "string" }, "example": "harbor" }, { "name": "office", "in": "query", "required": false, "description": "Keep the marks of one office. One of: US, EU.", "schema": { "type": "string" } }, { "name": "status", "in": "query", "required": false, "description": "Keep live or dead marks. One of: live, dead.", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "required": false, "description": "Comma-separated top-level keys to keep: us, eu, marks.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A word's trademark counts and its exact-match marks.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "meta", "links" ], "properties": { "data": { "type": "object", "properties": { "us": { "type": "object", "properties": { "liveCount": { "type": "integer" }, "classes": { "type": "array", "items": { "type": "string" } } } }, "eu": { "type": "object", "properties": { "liveCount": { "nullable": true, "type": "integer" }, "classes": { "type": "array", "items": { "type": "string" } } } }, "marks": { "type": "array", "items": { "type": "object", "properties": { "office": { "type": "string", "enum": [ "US", "EU" ] }, "serial": { "type": "string" }, "mark": { "type": "string" }, "registration": { "nullable": true, "type": "string" }, "status": { "type": "string", "enum": [ "live", "dead" ] }, "owner": { "nullable": true, "type": "string" }, "filed": { "format": "date", "nullable": true, "type": "string" }, "registered": { "format": "date", "nullable": true, "type": "string" }, "niceClasses": { "type": "array", "items": { "type": "string" } }, "goods": { "description": "At most 500 characters, live trademarks only.", "nullable": true, "type": "string" }, "url": { "nullable": true, "type": "string" } } } } } }, "meta": { "$ref": "#/components/schemas/Meta" }, "links": { "$ref": "#/components/schemas/Links" } } }, "example": { "data": { "us": { "liveCount": 3, "classes": [ "009", "042" ] }, "eu": { "liveCount": null, "classes": [] }, "marks": [ { "office": "US", "serial": "97412233", "mark": "HARBOR", "registration": "7011245", "status": "live", "owner": "Harbor Labs Inc.", "filed": "2022-05-17", "registered": "2023-04-11", "niceClasses": [ "009" ], "goods": "Downloadable software for data backup", "url": "https://tsdr.uspto.gov/#caseNumber=97412233" } ] } } } } }, "304": { "description": "Not modified (`If-None-Match`)." }, "400": { "$ref": "#/components/responses/Problem400" }, "401": { "$ref": "#/components/responses/Problem401" }, "403": { "$ref": "#/components/responses/Problem403" }, "404": { "$ref": "#/components/responses/Problem404" }, "422": { "$ref": "#/components/responses/Problem422" }, "429": { "$ref": "#/components/responses/Problem429" }, "500": { "$ref": "#/components/responses/Problem500" }, "503": { "$ref": "#/components/responses/Problem503" } }, "x-tier": "keyed", "x-plan": "investor", "x-rapidapi-host": "word-intelligence.p.rapidapi.com" } }, "/words/{word}/notability": { "get": { "operationId": "get_word_notability", "summary": "A word's Wikipedia and Wikidata facts.", "description": "The article title after redirects, its backlinks (capped at 500), its languages, the Wikidata id and description. 404 when no read exists yet.", "tags": [ "words" ], "parameters": [ { "name": "word", "in": "path", "required": true, "description": "The catalog slug, the word, or `wrd_`.", "schema": { "type": "string" }, "example": "harbor" }, { "name": "fields", "in": "query", "required": false, "description": "Comma-separated top-level keys to keep: wikipediaTitle, backlinks, languages, wikidataId, description.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A word's Wikipedia and Wikidata facts.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "meta", "links" ], "properties": { "data": { "type": "object", "properties": { "wikipediaTitle": { "nullable": true, "type": "string" }, "backlinks": { "nullable": true, "type": "integer" }, "languages": { "nullable": true, "type": "integer" }, "wikidataId": { "nullable": true, "type": "string" }, "description": { "nullable": true, "type": "string" } } }, "meta": { "$ref": "#/components/schemas/Meta" }, "links": { "$ref": "#/components/schemas/Links" } } }, "example": { "data": { "wikipediaTitle": "Harbor", "backlinks": 500, "languages": 112, "wikidataId": "Q283202", "description": "sheltered body of water where ships can be docked" } } } } }, "304": { "description": "Not modified (`If-None-Match`)." }, "400": { "$ref": "#/components/responses/Problem400" }, "401": { "$ref": "#/components/responses/Problem401" }, "403": { "$ref": "#/components/responses/Problem403" }, "404": { "$ref": "#/components/responses/Problem404" }, "422": { "$ref": "#/components/responses/Problem422" }, "429": { "$ref": "#/components/responses/Problem429" }, "500": { "$ref": "#/components/responses/Problem500" }, "503": { "$ref": "#/components/responses/Problem503" } }, "x-tier": "free", "x-plan": "investor", "x-rapidapi-host": "word-intelligence.p.rapidapi.com" } }, "/words/{word}/market": { "get": { "operationId": "get_word_market", "summary": "A word's sales and auction aggregates from the nightly update.", "description": "Usable sales of the word itself over 12 months and 30 days, the median from three sales, the count of endings it sold on and its open auctions per ending. Aggregates only.", "tags": [ "words" ], "parameters": [ { "name": "word", "in": "path", "required": true, "description": "The catalog slug, the word, or `wrd_`.", "schema": { "type": "string" }, "example": "harbor" }, { "name": "fields", "in": "query", "required": false, "description": "Comma-separated top-level keys to keep: sales12m, sales30d, medianFromThree, endingsSoldOn, openAuctionsByEnding.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A word's sales and auction aggregates from the nightly update.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "meta", "links" ], "properties": { "data": { "type": "object", "properties": { "sales12m": { "type": "integer" }, "sales30d": { "type": "integer" }, "medianFromThree": { "description": "USD, only from 3 sales.", "nullable": true, "type": "integer" }, "endingsSoldOn": { "type": "integer" }, "openAuctionsByEnding": { "type": "object", "additionalProperties": { "type": "integer" }, "description": "`{ ending: count }`." } } }, "meta": { "$ref": "#/components/schemas/Meta" }, "links": { "$ref": "#/components/schemas/Links" } } }, "example": { "data": { "sales12m": 4, "sales30d": 1, "medianFromThree": 2150, "endingsSoldOn": 3, "openAuctionsByEnding": { "com": 1, "io": 1 } } } } } }, "304": { "description": "Not modified (`If-None-Match`)." }, "400": { "$ref": "#/components/responses/Problem400" }, "401": { "$ref": "#/components/responses/Problem401" }, "403": { "$ref": "#/components/responses/Problem403" }, "404": { "$ref": "#/components/responses/Problem404" }, "422": { "$ref": "#/components/responses/Problem422" }, "429": { "$ref": "#/components/responses/Problem429" }, "500": { "$ref": "#/components/responses/Problem500" }, "503": { "$ref": "#/components/responses/Problem503" } }, "x-tier": "free", "x-plan": "investor", "x-rapidapi-host": "word-intelligence.p.rapidapi.com" } }, "/words/{word}/related": { "get": { "operationId": "list_related_words", "summary": "A word's synonyms then related words, closest first, with their open names.", "description": "Synonyms (levels 0 and 1) then related words (level 2), closest first. Neighbours with a deny class are left out.", "tags": [ "words" ], "parameters": [ { "name": "word", "in": "path", "required": true, "description": "The catalog slug, the word, or `wrd_`.", "schema": { "type": "string" }, "example": "harbor" }, { "name": "limit", "in": "query", "required": false, "description": "Rows, 1 to 50. Default: 50.", "schema": { "type": "integer", "minimum": 1, "maximum": 50 } }, { "name": "fields", "in": "query", "required": false, "description": "Comma-separated top-level keys to keep: word, slug, relation, openNames.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A word's synonyms then related words, closest first, with their open names.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "meta", "links" ], "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "word": { "type": "string" }, "slug": { "nullable": true, "type": "string" }, "relation": { "type": "string", "enum": [ "synonym", "related" ] }, "openNames": { "description": "Open to register plus for sale; null: not counted yet.", "nullable": true, "type": "integer" } } } }, "meta": { "$ref": "#/components/schemas/Meta" }, "links": { "$ref": "#/components/schemas/Links" } } }, "example": { "data": [ { "word": "port", "slug": "port", "relation": "synonym", "openNames": 6 } ] } } } }, "304": { "description": "Not modified (`If-None-Match`)." }, "400": { "$ref": "#/components/responses/Problem400" }, "401": { "$ref": "#/components/responses/Problem401" }, "403": { "$ref": "#/components/responses/Problem403" }, "404": { "$ref": "#/components/responses/Problem404" }, "422": { "$ref": "#/components/responses/Problem422" }, "429": { "$ref": "#/components/responses/Problem429" }, "500": { "$ref": "#/components/responses/Problem500" }, "503": { "$ref": "#/components/responses/Problem503" } }, "x-tier": "keyed", "x-plan": "investor", "x-rapidapi-host": "word-intelligence.p.rapidapi.com" } }, "/words/{word}/fit": { "get": { "operationId": "list_word_fits", "summary": "How well the word fits each ending whose keywords list it.", "description": "The stored pair fit of the word on each ending (`basis: rated`), else 50 (`basis: default`), in the keyword's rank on the ending. `tld` asks one ending.", "tags": [ "words" ], "parameters": [ { "name": "word", "in": "path", "required": true, "description": "The catalog slug, the word, or `wrd_`.", "schema": { "type": "string" }, "example": "harbor" }, { "name": "tld", "in": "query", "required": false, "description": "One bare ending.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "Rows, 1 to 50. Default: 50.", "schema": { "type": "integer", "minimum": 1, "maximum": 50 } }, { "name": "fields", "in": "query", "required": false, "description": "Comma-separated top-level keys to keep: ending, fit, basis.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "How well the word fits each ending whose keywords list it.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "meta", "links" ], "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "ending": { "type": "string" }, "fit": { "type": "integer", "minimum": 0, "maximum": 100 }, "basis": { "type": "string", "enum": [ "rated", "default" ] } } } }, "meta": { "$ref": "#/components/schemas/Meta" }, "links": { "$ref": "#/components/schemas/Links" } } }, "example": { "data": [ { "ending": "travel", "fit": 82, "basis": "rated" } ] } } } }, "304": { "description": "Not modified (`If-None-Match`)." }, "400": { "$ref": "#/components/responses/Problem400" }, "401": { "$ref": "#/components/responses/Problem401" }, "403": { "$ref": "#/components/responses/Problem403" }, "404": { "$ref": "#/components/responses/Problem404" }, "422": { "$ref": "#/components/responses/Problem422" }, "429": { "$ref": "#/components/responses/Problem429" }, "500": { "$ref": "#/components/responses/Problem500" }, "503": { "$ref": "#/components/responses/Problem503" } }, "x-tier": "keyed", "x-plan": "investor", "x-rapidapi-host": "word-intelligence.p.rapidapi.com" } }, "/words/{word}/request": { "post": { "operationId": "request_word", "summary": "Brings a word into the catalog: checks it now and queues an accepted word for the intake.", "description": "Billed `Intake=1` only when the gate accepted the word (202 `accepted`, `Retry-After: 600`, poll the request); a word already in the catalog answers 200 `in_catalog`, a queued one 202 `queued` with its request id, a refused one 422 with the reason as `code` (`not_a_word`, `brand`, `offensive`), all billed `Intake=0`. 10 words a UTC day per consumer and 100 for the whole API, refused words included. When the gate cannot answer: 503 `gate_unavailable`, `Retry-After: 60`, never billed.", "tags": [ "words" ], "parameters": [ { "name": "word", "in": "path", "required": true, "description": "One lowercase word of 2 to 63 letters a to z; no slug or id form.", "schema": { "type": "string" }, "example": "glimmerly" } ], "responses": { "200": { "description": "Brings a word into the catalog: checks it now and queues an accepted word for the intake.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "meta", "links" ], "properties": { "data": { "type": "object", "required": [ "status" ], "properties": { "status": { "type": "string", "enum": [ "in_catalog", "accepted", "queued" ] }, "requestId": { "type": "string", "format": "uuid", "description": "On `accepted` and `queued`." }, "poll": { "type": "string", "description": "`/v1/words/requests/`; on `accepted`." }, "word": { "type": "object", "description": "On `in_catalog`.", "properties": { "id": { "type": "string", "description": "`wrd_`." }, "slug": { "nullable": true, "type": "string" }, "origin": { "type": "string", "enum": [ "dictionary", "trend", "api", "review" ] } } } } }, "meta": { "$ref": "#/components/schemas/Meta" }, "links": { "$ref": "#/components/schemas/Links" } } }, "example": { "data": { "status": "accepted", "requestId": "6b0f6e3c-1d2a-4f6e-9a51-0c7d3b8e2f44", "poll": "/v1/words/requests/6b0f6e3c-1d2a-4f6e-9a51-0c7d3b8e2f44" } } } } }, "202": { "description": "Accepted: the answer so far; poll `Location` after `Retry-After` seconds.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "meta", "links" ], "properties": { "data": { "type": "object", "required": [ "status" ], "properties": { "status": { "type": "string", "enum": [ "in_catalog", "accepted", "queued" ] }, "requestId": { "type": "string", "format": "uuid", "description": "On `accepted` and `queued`." }, "poll": { "type": "string", "description": "`/v1/words/requests/`; on `accepted`." }, "word": { "type": "object", "description": "On `in_catalog`.", "properties": { "id": { "type": "string", "description": "`wrd_`." }, "slug": { "nullable": true, "type": "string" }, "origin": { "type": "string", "enum": [ "dictionary", "trend", "api", "review" ] } } } } }, "meta": { "$ref": "#/components/schemas/Meta" }, "links": { "$ref": "#/components/schemas/Links" } } }, "example": { "data": { "status": "accepted", "requestId": "6b0f6e3c-1d2a-4f6e-9a51-0c7d3b8e2f44", "poll": "/v1/words/requests/6b0f6e3c-1d2a-4f6e-9a51-0c7d3b8e2f44" } } } } }, "400": { "$ref": "#/components/responses/Problem400" }, "401": { "$ref": "#/components/responses/Problem401" }, "403": { "$ref": "#/components/responses/Problem403" }, "404": { "$ref": "#/components/responses/Problem404" }, "422": { "$ref": "#/components/responses/Problem422" }, "429": { "$ref": "#/components/responses/Problem429" }, "500": { "$ref": "#/components/responses/Problem500" }, "503": { "$ref": "#/components/responses/Problem503" } }, "x-tier": "keyed", "x-plan": "investor", "x-metered": "Intake", "x-rapidapi-host": "word-intelligence.p.rapidapi.com" } }, "/words/requests/{requestId}": { "get": { "operationId": "get_word_request", "summary": "The state of a word request: queued, ready with its catalog word, refused or failed.", "description": "Reads the request by its id. `queued` while the intake has not finished; `ready` names the catalog word and whether its first scan of every ending ran; `rejected` the reason code. Not metered.", "tags": [ "words" ], "parameters": [ { "name": "requestId", "in": "path", "required": true, "description": "The id the request answered.", "schema": { "type": "string", "format": "uuid" }, "example": "6b0f6e3c-1d2a-4f6e-9a51-0c7d3b8e2f44" }, { "name": "fields", "in": "query", "required": false, "description": "Comma-separated top-level keys to keep: requestId, status, word, scan, reason, requestedAt, resolvedAt.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The state of a word request: queued, ready with its catalog word, refused or failed.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "meta", "links" ], "properties": { "data": { "type": "object", "required": [ "requestId", "status", "requestedAt", "resolvedAt" ], "properties": { "requestId": { "type": "string", "format": "uuid" }, "status": { "type": "string", "enum": [ "queued", "ready", "rejected", "failed" ] }, "word": { "description": "On `ready`; null when the catalog no longer serves the word.", "properties": { "id": { "type": "string", "description": "`wrd_`." }, "slug": { "nullable": true, "type": "string" } }, "nullable": true, "type": "object" }, "scan": { "type": "string", "enum": [ "pending", "done" ], "description": "On `ready` with a word: whether the first scan of every ending ran." }, "reason": { "type": "string", "enum": [ "not_a_word", "brand", "offensive" ], "description": "On `rejected`." }, "requestedAt": { "type": "string", "format": "date-time" }, "resolvedAt": { "format": "date-time", "description": "Null while queued.", "nullable": true, "type": "string" } } }, "meta": { "$ref": "#/components/schemas/Meta" }, "links": { "$ref": "#/components/schemas/Links" } } }, "example": { "data": { "requestId": "6b0f6e3c-1d2a-4f6e-9a51-0c7d3b8e2f44", "status": "ready", "word": { "id": "wrd_565120", "slug": "glimmerly" }, "scan": "pending", "requestedAt": "2026-11-05T09:14:02.000Z", "resolvedAt": "2026-11-05T09:20:11.000Z" } } } } }, "304": { "description": "Not modified (`If-None-Match`)." }, "400": { "$ref": "#/components/responses/Problem400" }, "401": { "$ref": "#/components/responses/Problem401" }, "403": { "$ref": "#/components/responses/Problem403" }, "404": { "$ref": "#/components/responses/Problem404" }, "422": { "$ref": "#/components/responses/Problem422" }, "429": { "$ref": "#/components/responses/Problem429" }, "500": { "$ref": "#/components/responses/Problem500" }, "503": { "$ref": "#/components/responses/Problem503" } }, "x-tier": "keyed", "x-plan": "investor", "x-rapidapi-host": "word-intelligence.p.rapidapi.com" } }, "/meta/tlds": { "get": { "operationId": "get_meta_tlds", "summary": "The v1 TLD list path, redirected to /tlds for one release.", "description": "Answers `308` to `/tlds` on the same host, `listing=public` carried as `publicSet=true`, any other query kept. Removed after one release.", "tags": [ "shared" ], "parameters": [ { "name": "listing", "in": "query", "required": false, "description": "v1's switch: `public` becomes `publicSet=true`. One of: all, public.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The v1 TLD list path, redirected to /tlds for one release.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "meta", "links" ], "properties": { "data": { "description": "No body: a `308` with `Location`.", "nullable": true }, "meta": { "$ref": "#/components/schemas/Meta" }, "links": { "$ref": "#/components/schemas/Links" } } }, "example": { "data": null } } } }, "304": { "description": "Not modified (`If-None-Match`)." }, "400": { "$ref": "#/components/responses/Problem400" }, "401": { "$ref": "#/components/responses/Problem401" }, "403": { "$ref": "#/components/responses/Problem403" }, "404": { "$ref": "#/components/responses/Problem404" }, "422": { "$ref": "#/components/responses/Problem422" }, "429": { "$ref": "#/components/responses/Problem429" }, "500": { "$ref": "#/components/responses/Problem500" }, "503": { "$ref": "#/components/responses/Problem503" } }, "x-tier": "free", "x-rapidapi-host": "word-intelligence.p.rapidapi.com" } }, "/editions/{persona}/latest": { "get": { "operationId": "get_latest_edition", "summary": "The latest published daily edition of one page.", "description": "The edition as the page shows it to a visitor: its trends in edition order, at most 5 open names, the rest as counts.", "tags": [ "shared" ], "parameters": [ { "name": "persona", "in": "path", "required": true, "description": "Business Ideas (`founder`) or Trending Domains (`investor`).", "schema": { "type": "string", "enum": [ "founder", "investor" ] }, "example": "founder" }, { "name": "fields", "in": "query", "required": false, "description": "Comma-separated top-level keys to keep: persona, date, publishAt, trendCount, nameCount, openCount, previousDate, nextDate, trends.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The latest published daily edition of one page.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "meta", "links" ], "properties": { "data": { "type": "object", "properties": { "persona": { "type": "string", "enum": [ "founder", "investor" ] }, "date": { "type": "string", "format": "date" }, "publishAt": { "type": "string", "format": "date-time" }, "trendCount": { "type": "integer" }, "nameCount": { "type": "integer" }, "openCount": { "type": "integer", "maximum": 5 }, "previousDate": { "format": "date", "nullable": true, "type": "string" }, "nextDate": { "format": "date", "nullable": true, "type": "string" }, "trends": { "type": "array", "items": { "type": "object", "properties": { "slug": { "type": "string" }, "name": { "type": "string" }, "category": { "nullable": true, "type": "string" }, "definition": { "nullable": true, "type": "string" }, "volume": { "description": "Searches a month.", "nullable": true, "type": "integer" }, "growth": { "description": "Growth, percent.", "nullable": true, "type": "number" }, "lane": { "enum": [ "weekly", "yearly", null ], "nullable": true, "type": "string" }, "headWord": { "nullable": true, "type": "string" }, "whyNow": { "nullable": true, "type": "string" }, "openNames": { "nullable": true, "type": "integer" }, "lockedCount": { "type": "integer", "description": "Names this audience cannot open, a count." }, "rows": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "word": { "type": "string" }, "ending": { "type": "string" }, "matchKind": { "type": "string", "enum": [ "exact", "related" ] }, "relation": { "nullable": true, "type": "string" }, "status": { "type": "string", "enum": [ "available", "premium", "forSale", "auction", "expiring" ] }, "price": { "nullable": true, "type": "number" }, "priceKind": { "enum": [ "registration", "premium", "marketplace", "auction", null ], "nullable": true, "type": "string" }, "quotedBy": { "nullable": true, "type": "string" }, "renewal": { "nullable": true, "type": "number" }, "fiveYearCost": { "description": "Founder page.", "nullable": true, "type": "number" }, "value": { "description": "Investor page; null past the public cap on Est. profit.", "nullable": true, "type": "number" }, "upsidePercent": { "description": "Capped on the public page.", "nullable": true, "type": "number" }, "upsideCapped": { "type": "boolean" }, "liquidity": { "enum": [ "high", "medium", "low", null ], "nullable": true, "type": "string" }, "verdict": { "properties": { "label": { "type": "string", "enum": [ "strong", "good", "risky" ] }, "confidence": { "type": "string", "enum": [ "high", "medium", "low" ] } }, "nullable": true, "type": "object" }, "rating": { "type": "string", "enum": [ "strong", "good", "risky", "unrated" ] }, "ideas": { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string" }, "idea": { "type": "string" }, "problem": { "type": "string" }, "customer": { "type": "string" }, "valueProp": { "type": "string" }, "whyNow": { "type": "string" }, "monetization": { "type": "string" }, "nameFit": { "type": "string" }, "checklist": { "type": "array", "items": { "type": "string" } } } } } } } } } } } } }, "meta": { "$ref": "#/components/schemas/Meta" }, "links": { "$ref": "#/components/schemas/Links" } } }, "example": { "data": { "persona": "founder", "date": "2026-11-05", "publishAt": "2026-11-05T06:00:00.000Z", "trendCount": 25, "nameCount": 25, "openCount": 5, "previousDate": "2026-11-04", "nextDate": null, "trends": [ { "slug": "agentic-checkout", "name": "Agentic checkout", "category": "Commerce", "definition": "AI agents that complete purchases for shoppers.", "volume": 2400, "growth": 180, "lane": "weekly", "headWord": "checkout", "whyNow": "Card networks opened agent payments this autumn.", "openNames": 1, "lockedCount": 0, "rows": [ { "name": "cartpilot.com", "word": "cartpilot", "ending": "com", "matchKind": "related", "relation": "compound", "status": "forSale", "price": 2495, "priceKind": "marketplace", "quotedBy": "Afternic", "renewal": 10.44, "fiveYearCost": 2536.76, "value": null, "upsidePercent": null, "upsideCapped": false, "liquidity": "medium", "verdict": { "label": "good", "confidence": "medium" }, "rating": "good", "ideas": [ { "title": "Checkout agent for small shops", "idea": "Let shoppers' AI agents buy from any Shopify store.", "problem": "Agents cannot check out on small stores.", "customer": "Independent merchants", "valueProp": "Sales from agent traffic", "whyNow": "Agent payments opened this autumn.", "monetization": "Per-order fee", "nameFit": "Says cart and autopilot.", "checklist": [ "Trademark search" ] } ] } ] } ] } } } } }, "304": { "description": "Not modified (`If-None-Match`)." }, "400": { "$ref": "#/components/responses/Problem400" }, "401": { "$ref": "#/components/responses/Problem401" }, "403": { "$ref": "#/components/responses/Problem403" }, "404": { "$ref": "#/components/responses/Problem404" }, "422": { "$ref": "#/components/responses/Problem422" }, "429": { "$ref": "#/components/responses/Problem429" }, "500": { "$ref": "#/components/responses/Problem500" }, "503": { "$ref": "#/components/responses/Problem503" } }, "x-tier": "free", "x-rapidapi-host": "word-intelligence.p.rapidapi.com" } }, "/editions/{persona}/{date}": { "get": { "operationId": "get_edition", "summary": "One dated published edition of one page.", "description": "The edition of one UTC day as the page shows it to a visitor, at most 5 open names.", "tags": [ "shared" ], "parameters": [ { "name": "persona", "in": "path", "required": true, "description": "Business Ideas (`founder`) or Trending Domains (`investor`).", "schema": { "type": "string", "enum": [ "founder", "investor" ] }, "example": "founder" }, { "name": "date", "in": "path", "required": true, "description": "The edition day, UTC.", "schema": { "type": "string", "format": "date" }, "example": "2026-11-02" }, { "name": "fields", "in": "query", "required": false, "description": "Comma-separated top-level keys to keep: persona, date, publishAt, trendCount, nameCount, openCount, previousDate, nextDate, trends.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "One dated published edition of one page.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "meta", "links" ], "properties": { "data": { "type": "object", "properties": { "persona": { "type": "string", "enum": [ "founder", "investor" ] }, "date": { "type": "string", "format": "date" }, "publishAt": { "type": "string", "format": "date-time" }, "trendCount": { "type": "integer" }, "nameCount": { "type": "integer" }, "openCount": { "type": "integer", "maximum": 5 }, "previousDate": { "format": "date", "nullable": true, "type": "string" }, "nextDate": { "format": "date", "nullable": true, "type": "string" }, "trends": { "type": "array", "items": { "type": "object", "properties": { "slug": { "type": "string" }, "name": { "type": "string" }, "category": { "nullable": true, "type": "string" }, "definition": { "nullable": true, "type": "string" }, "volume": { "description": "Searches a month.", "nullable": true, "type": "integer" }, "growth": { "description": "Growth, percent.", "nullable": true, "type": "number" }, "lane": { "enum": [ "weekly", "yearly", null ], "nullable": true, "type": "string" }, "headWord": { "nullable": true, "type": "string" }, "whyNow": { "nullable": true, "type": "string" }, "openNames": { "nullable": true, "type": "integer" }, "lockedCount": { "type": "integer", "description": "Names this audience cannot open, a count." }, "rows": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "word": { "type": "string" }, "ending": { "type": "string" }, "matchKind": { "type": "string", "enum": [ "exact", "related" ] }, "relation": { "nullable": true, "type": "string" }, "status": { "type": "string", "enum": [ "available", "premium", "forSale", "auction", "expiring" ] }, "price": { "nullable": true, "type": "number" }, "priceKind": { "enum": [ "registration", "premium", "marketplace", "auction", null ], "nullable": true, "type": "string" }, "quotedBy": { "nullable": true, "type": "string" }, "renewal": { "nullable": true, "type": "number" }, "fiveYearCost": { "description": "Founder page.", "nullable": true, "type": "number" }, "value": { "description": "Investor page; null past the public cap on Est. profit.", "nullable": true, "type": "number" }, "upsidePercent": { "description": "Capped on the public page.", "nullable": true, "type": "number" }, "upsideCapped": { "type": "boolean" }, "liquidity": { "enum": [ "high", "medium", "low", null ], "nullable": true, "type": "string" }, "verdict": { "properties": { "label": { "type": "string", "enum": [ "strong", "good", "risky" ] }, "confidence": { "type": "string", "enum": [ "high", "medium", "low" ] } }, "nullable": true, "type": "object" }, "rating": { "type": "string", "enum": [ "strong", "good", "risky", "unrated" ] }, "ideas": { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string" }, "idea": { "type": "string" }, "problem": { "type": "string" }, "customer": { "type": "string" }, "valueProp": { "type": "string" }, "whyNow": { "type": "string" }, "monetization": { "type": "string" }, "nameFit": { "type": "string" }, "checklist": { "type": "array", "items": { "type": "string" } } } } } } } } } } } } }, "meta": { "$ref": "#/components/schemas/Meta" }, "links": { "$ref": "#/components/schemas/Links" } } }, "example": { "data": { "persona": "founder", "date": "2026-11-02", "publishAt": "2026-11-05T06:00:00.000Z", "trendCount": 25, "nameCount": 25, "openCount": 5, "previousDate": "2026-11-01", "nextDate": "2026-11-03", "trends": [ { "slug": "agentic-checkout", "name": "Agentic checkout", "category": "Commerce", "definition": "AI agents that complete purchases for shoppers.", "volume": 2400, "growth": 180, "lane": "weekly", "headWord": "checkout", "whyNow": "Card networks opened agent payments this autumn.", "openNames": 1, "lockedCount": 0, "rows": [ { "name": "cartpilot.com", "word": "cartpilot", "ending": "com", "matchKind": "related", "relation": "compound", "status": "forSale", "price": 2495, "priceKind": "marketplace", "quotedBy": "Afternic", "renewal": 10.44, "fiveYearCost": 2536.76, "value": null, "upsidePercent": null, "upsideCapped": false, "liquidity": "medium", "verdict": { "label": "good", "confidence": "medium" }, "rating": "good", "ideas": [ { "title": "Checkout agent for small shops", "idea": "Let shoppers' AI agents buy from any Shopify store.", "problem": "Agents cannot check out on small stores.", "customer": "Independent merchants", "valueProp": "Sales from agent traffic", "whyNow": "Agent payments opened this autumn.", "monetization": "Per-order fee", "nameFit": "Says cart and autopilot.", "checklist": [ "Trademark search" ] } ] } ] } ] } } } } }, "304": { "description": "Not modified (`If-None-Match`)." }, "400": { "$ref": "#/components/responses/Problem400" }, "401": { "$ref": "#/components/responses/Problem401" }, "403": { "$ref": "#/components/responses/Problem403" }, "404": { "$ref": "#/components/responses/Problem404" }, "422": { "$ref": "#/components/responses/Problem422" }, "429": { "$ref": "#/components/responses/Problem429" }, "500": { "$ref": "#/components/responses/Problem500" }, "503": { "$ref": "#/components/responses/Problem503" } }, "x-tier": "free", "x-rapidapi-host": "word-intelligence.p.rapidapi.com" } }, "/meta/enums": { "get": { "operationId": "get_meta_enums", "summary": "Every enum the payloads use, read from the code catalogs.", "description": "Name statuses, registry lifecycles and EPP statuses, lookup states, word shapes and origins, TLD kinds, agenda and event categories, edition lanes, the change types and subjects, the auction venues and the parking services.", "tags": [ "shared" ], "parameters": [ { "name": "fields", "in": "query", "required": false, "description": "Comma-separated top-level keys to keep: statuses, lifecycles, eppStatuses, lookupStates, wordShapes, wordOrigins, tldKinds, agendaCategories, eventCategories, editionLanes, changeEventTypes, changeEventSubjects, auctionVenues, parkingServices.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Every enum the payloads use, read from the code catalogs.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "meta", "links" ], "properties": { "data": { "type": "object", "required": [ "statuses", "lifecycles", "eppStatuses", "lookupStates", "wordShapes", "wordOrigins", "tldKinds", "agendaCategories", "eventCategories", "editionLanes", "changeEventTypes", "changeEventSubjects", "auctionVenues", "parkingServices" ], "properties": { "statuses": { "type": "array", "items": { "type": "string" } }, "lifecycles": { "type": "array", "items": { "type": "string" } }, "eppStatuses": { "type": "array", "items": { "type": "string" } }, "lookupStates": { "type": "array", "items": { "type": "string" } }, "wordShapes": { "type": "array", "items": { "type": "string" } }, "wordOrigins": { "type": "array", "items": { "type": "string" } }, "tldKinds": { "type": "array", "items": { "type": "string" } }, "agendaCategories": { "type": "array", "items": { "type": "string" } }, "eventCategories": { "type": "array", "items": { "type": "string" } }, "editionLanes": { "type": "array", "items": { "type": "string" } }, "changeEventTypes": { "type": "array", "items": { "type": "string" } }, "changeEventSubjects": { "type": "array", "items": { "type": "string" } }, "auctionVenues": { "type": "array", "items": { "type": "object", "required": [ "id", "label" ], "properties": { "id": { "type": "string", "enum": [ "godaddy", "dynadot", "namesilo", "namecheap", "snapnames", "domainlore" ] }, "label": { "type": "string" } } } }, "parkingServices": { "type": "array", "items": { "type": "object", "required": [ "id", "label", "kind" ], "properties": { "id": { "type": "string" }, "label": { "type": "string" }, "kind": { "type": "string", "enum": [ "marketplace", "parking", "dropcatch" ] } } } } } }, "meta": { "$ref": "#/components/schemas/Meta" }, "links": { "$ref": "#/components/schemas/Links" } } }, "example": { "data": { "statuses": [ "available", "premium", "resell", "expiring", "expired", "taken", "dormant", "sold", "unknown" ], "wordOrigins": [ "dictionary", "trend", "api", "review" ], "auctionVenues": [ { "id": "godaddy", "label": "GoDaddy" } ] } } } } }, "304": { "description": "Not modified (`If-None-Match`)." }, "400": { "$ref": "#/components/responses/Problem400" }, "401": { "$ref": "#/components/responses/Problem401" }, "403": { "$ref": "#/components/responses/Problem403" }, "404": { "$ref": "#/components/responses/Problem404" }, "422": { "$ref": "#/components/responses/Problem422" }, "429": { "$ref": "#/components/responses/Problem429" }, "500": { "$ref": "#/components/responses/Problem500" }, "503": { "$ref": "#/components/responses/Problem503" } }, "x-tier": "free", "x-rapidapi-host": "word-intelligence.p.rapidapi.com" } }, "/meta/freshness": { "get": { "operationId": "get_meta_freshness", "summary": "How current the scanner's passes are: the day's counts and each lane's state.", "description": "Names scanned today and checked in the last 24 hours, and per scanner lane the names its current or last pass covered and whether it is running.", "tags": [ "shared" ], "parameters": [ { "name": "fields", "in": "query", "required": false, "description": "Comma-separated top-level keys to keep: asOf, scannedToday, checkedLast24h, lanes.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "How current the scanner's passes are: the day's counts and each lane's state.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "meta", "links" ], "properties": { "data": { "type": "object", "required": [ "asOf", "scannedToday", "checkedLast24h", "lanes" ], "properties": { "asOf": { "format": "date-time", "nullable": true, "type": "string" }, "scannedToday": { "type": "integer" }, "checkedLast24h": { "type": "integer" }, "lanes": { "type": "array", "items": { "type": "object", "required": [ "lane", "scanned", "state" ], "properties": { "lane": { "type": "string" }, "scanned": { "nullable": true, "type": "integer" }, "state": { "type": "string", "enum": [ "running", "completed" ] } } } } } }, "meta": { "$ref": "#/components/schemas/Meta" }, "links": { "$ref": "#/components/schemas/Links" } } }, "example": { "data": { "asOf": "2026-11-05T06:00:00.000Z", "scannedToday": 1840022, "checkedLast24h": 611204, "lanes": [ { "lane": "timing", "scanned": 402118, "state": "completed" }, { "lane": "taken_refresh", "scanned": 88210, "state": "running" } ] } } } } }, "304": { "description": "Not modified (`If-None-Match`)." }, "400": { "$ref": "#/components/responses/Problem400" }, "401": { "$ref": "#/components/responses/Problem401" }, "403": { "$ref": "#/components/responses/Problem403" }, "404": { "$ref": "#/components/responses/Problem404" }, "422": { "$ref": "#/components/responses/Problem422" }, "429": { "$ref": "#/components/responses/Problem429" }, "500": { "$ref": "#/components/responses/Problem500" }, "503": { "$ref": "#/components/responses/Problem503" } }, "x-tier": "free", "x-rapidapi-host": "word-intelligence.p.rapidapi.com" } }, "/meta/datasets": { "get": { "operationId": "list_meta_datasets", "summary": "The GitHub datasets and the API path serving the same rows.", "description": "The catalog, edition and application datasets, then one repository per TLD with the UTC day of its last push.", "tags": [ "shared" ], "parameters": [ { "name": "fields", "in": "query", "required": false, "description": "Comma-separated top-level keys to keep: id, repository, url, endpoint, updatedOn.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The GitHub datasets and the API path serving the same rows.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "meta", "links" ], "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "id", "repository", "url", "endpoint", "updatedOn" ], "properties": { "id": { "type": "string" }, "repository": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "endpoint": { "nullable": true, "type": "string" }, "updatedOn": { "format": "date", "nullable": true, "type": "string" } } } }, "meta": { "$ref": "#/components/schemas/Meta" }, "links": { "$ref": "#/components/schemas/Links" } } }, "example": { "data": [ { "id": "trending-domains-business-ideas", "repository": "trending-domains-business-ideas", "url": "https://github.com/uniquedomains/trending-domains-business-ideas", "endpoint": "/editions/{persona}/latest", "updatedOn": null } ] } } } }, "304": { "description": "Not modified (`If-None-Match`)." }, "400": { "$ref": "#/components/responses/Problem400" }, "401": { "$ref": "#/components/responses/Problem401" }, "403": { "$ref": "#/components/responses/Problem403" }, "404": { "$ref": "#/components/responses/Problem404" }, "422": { "$ref": "#/components/responses/Problem422" }, "429": { "$ref": "#/components/responses/Problem429" }, "500": { "$ref": "#/components/responses/Problem500" }, "503": { "$ref": "#/components/responses/Problem503" } }, "x-tier": "free", "x-rapidapi-host": "word-intelligence.p.rapidapi.com" } }, "/meta/trademark-classes": { "get": { "operationId": "list_meta_trademark_classes", "summary": "The 45 Nice classes a trademark is filed under.", "description": "Static, in class order: 1 to 34 are goods, 35 to 45 services.", "tags": [ "shared" ], "parameters": [ { "name": "fields", "in": "query", "required": false, "description": "Comma-separated top-level keys to keep: class, title, kind.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The 45 Nice classes a trademark is filed under.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "meta", "links" ], "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "class", "title", "kind" ], "properties": { "class": { "type": "integer", "minimum": 1, "maximum": 45 }, "title": { "type": "string" }, "kind": { "type": "string", "enum": [ "goods", "services" ] } } } }, "meta": { "$ref": "#/components/schemas/Meta" }, "links": { "$ref": "#/components/schemas/Links" } } }, "example": { "data": [ { "class": 9, "title": "Scientific and electronic apparatus, software", "kind": "goods" } ] } } } }, "304": { "description": "Not modified (`If-None-Match`)." }, "400": { "$ref": "#/components/responses/Problem400" }, "401": { "$ref": "#/components/responses/Problem401" }, "403": { "$ref": "#/components/responses/Problem403" }, "404": { "$ref": "#/components/responses/Problem404" }, "422": { "$ref": "#/components/responses/Problem422" }, "429": { "$ref": "#/components/responses/Problem429" }, "500": { "$ref": "#/components/responses/Problem500" }, "503": { "$ref": "#/components/responses/Problem503" } }, "x-tier": "free", "x-rapidapi-host": "word-intelligence.p.rapidapi.com" } }, "/meta/providers": { "get": { "operationId": "get_meta_providers", "summary": "Registrar identities and the auction venue and parking service catalogs.", "description": "Registrars in catalog order with their IANA id and homepage, the seven auction venues and the parking services the scanner recognises.", "tags": [ "shared" ], "parameters": [ { "name": "fields", "in": "query", "required": false, "description": "Comma-separated top-level keys to keep: registrars, auctionVenues, parkingServices.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Registrar identities and the auction venue and parking service catalogs.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "meta", "links" ], "properties": { "data": { "type": "object", "required": [ "registrars", "auctionVenues", "parkingServices" ], "properties": { "registrars": { "type": "array", "items": { "type": "object", "required": [ "slug", "name", "ianaId", "homepageUrl" ], "properties": { "slug": { "type": "string" }, "name": { "type": "string" }, "ianaId": { "nullable": true, "type": "integer" }, "homepageUrl": { "nullable": true, "type": "string" } } } }, "auctionVenues": { "type": "array", "items": { "type": "object", "required": [ "id", "label" ], "properties": { "id": { "type": "string", "enum": [ "godaddy", "dynadot", "namesilo", "namecheap", "snapnames", "domainlore" ] }, "label": { "type": "string" } } } }, "parkingServices": { "type": "array", "items": { "type": "object", "required": [ "id", "label", "kind" ], "properties": { "id": { "type": "string" }, "label": { "type": "string" }, "kind": { "type": "string", "enum": [ "marketplace", "parking", "dropcatch" ] } } } } } }, "meta": { "$ref": "#/components/schemas/Meta" }, "links": { "$ref": "#/components/schemas/Links" } } }, "example": { "data": { "registrars": [ { "slug": "porkbun", "name": "Porkbun", "ianaId": 1861, "homepageUrl": "https://porkbun.com" } ], "auctionVenues": [ { "id": "godaddy", "label": "GoDaddy" } ], "parkingServices": [ { "id": "sedo", "label": "Sedo", "kind": "marketplace" } ] } } } } }, "304": { "description": "Not modified (`If-None-Match`)." }, "400": { "$ref": "#/components/responses/Problem400" }, "401": { "$ref": "#/components/responses/Problem401" }, "403": { "$ref": "#/components/responses/Problem403" }, "404": { "$ref": "#/components/responses/Problem404" }, "422": { "$ref": "#/components/responses/Problem422" }, "429": { "$ref": "#/components/responses/Problem429" }, "500": { "$ref": "#/components/responses/Problem500" }, "503": { "$ref": "#/components/responses/Problem503" } }, "x-tier": "free", "x-rapidapi-host": "word-intelligence.p.rapidapi.com" } }, "/meta/openapi.json": { "get": { "operationId": "get_openapi", "summary": "The OpenAPI document of the API, whole or for one listing, in its 3.1 or 3.0 form.", "description": "Built from the typed endpoint catalog, served bare (no envelope). Each RapidAPI listing imports its own document with `listing`, in the 3.0 form (`oas=3.0`), the one RapidAPI's import accepts.", "tags": [ "shared" ], "parameters": [ { "name": "listing", "in": "query", "required": false, "description": "One RapidAPI listing's paths (the eight APIs and the eight focused listings) plus the shared ones; every path when absent. One of: names, words, catalog, tlds, registrars, market, trends, agenda, availability, whois, appraisal, expired, auctions, sales-history, price-comparison, trending-topics.", "schema": { "type": "string" } }, { "name": "oas", "in": "query", "required": false, "description": "The OpenAPI version: `3.1` (the default) or `3.0`, the same paths and operations with 3.0 schemas (`nullable` for a null type). One of: 3.1, 3.0. Default: 3.1.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The OpenAPI document of the API, whole or for one listing, in its 3.1 or 3.0 form.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "meta", "links" ], "properties": { "data": { "type": "object", "description": "An OpenAPI 3.1 document." }, "meta": { "$ref": "#/components/schemas/Meta" }, "links": { "$ref": "#/components/schemas/Links" } } }, "example": { "data": { "openapi": "3.1.0", "info": { "title": "Unique Domains API", "version": "1.0.0" } } } } } }, "304": { "description": "Not modified (`If-None-Match`)." }, "400": { "$ref": "#/components/responses/Problem400" }, "401": { "$ref": "#/components/responses/Problem401" }, "403": { "$ref": "#/components/responses/Problem403" }, "404": { "$ref": "#/components/responses/Problem404" }, "422": { "$ref": "#/components/responses/Problem422" }, "429": { "$ref": "#/components/responses/Problem429" }, "500": { "$ref": "#/components/responses/Problem500" }, "503": { "$ref": "#/components/responses/Problem503" } }, "x-tier": "free", "x-rapidapi-host": "word-intelligence.p.rapidapi.com" } }, "/meta/llms.txt": { "get": { "operationId": "get_llms_txt", "summary": "The free endpoints as plain text for language models.", "description": "`text/plain`, generated from the catalog, served bare (no envelope).", "tags": [ "shared" ], "parameters": [], "responses": { "200": { "description": "The free endpoints as plain text for language models.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "meta", "links" ], "properties": { "data": { "type": "string" }, "meta": { "$ref": "#/components/schemas/Meta" }, "links": { "$ref": "#/components/schemas/Links" } } }, "example": { "data": "# Unique Domains API" } } } }, "304": { "description": "Not modified (`If-None-Match`)." }, "400": { "$ref": "#/components/responses/Problem400" }, "401": { "$ref": "#/components/responses/Problem401" }, "403": { "$ref": "#/components/responses/Problem403" }, "404": { "$ref": "#/components/responses/Problem404" }, "422": { "$ref": "#/components/responses/Problem422" }, "429": { "$ref": "#/components/responses/Problem429" }, "500": { "$ref": "#/components/responses/Problem500" }, "503": { "$ref": "#/components/responses/Problem503" } }, "x-tier": "free", "x-rapidapi-host": "word-intelligence.p.rapidapi.com" } }, "/meta/health": { "get": { "operationId": "get_health", "summary": "Liveness, with no database read.", "description": "Answers `ok` with the server time.", "tags": [ "shared" ], "parameters": [ { "name": "fields", "in": "query", "required": false, "description": "Comma-separated top-level keys to keep: status, asOf.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Liveness, with no database read.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "meta", "links" ], "properties": { "data": { "type": "object", "required": [ "status", "asOf" ], "properties": { "status": { "type": "string", "enum": [ "ok" ] }, "asOf": { "type": "string", "format": "date-time" } } }, "meta": { "$ref": "#/components/schemas/Meta" }, "links": { "$ref": "#/components/schemas/Links" } } }, "example": { "data": { "status": "ok", "asOf": "2026-11-05T09:14:02.000Z" } } } } }, "304": { "description": "Not modified (`If-None-Match`)." }, "400": { "$ref": "#/components/responses/Problem400" }, "401": { "$ref": "#/components/responses/Problem401" }, "403": { "$ref": "#/components/responses/Problem403" }, "404": { "$ref": "#/components/responses/Problem404" }, "422": { "$ref": "#/components/responses/Problem422" }, "429": { "$ref": "#/components/responses/Problem429" }, "500": { "$ref": "#/components/responses/Problem500" }, "503": { "$ref": "#/components/responses/Problem503" } }, "x-tier": "free", "x-rapidapi-host": "word-intelligence.p.rapidapi.com" } } }, "components": { "schemas": { "Problem": { "type": "object", "required": [ "type", "title", "status", "detail", "instance", "code" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string", "enum": [ "validation_failed", "cursor_invalid", "unsupported_field", "unsupported_format", "invalid_proxy_secret", "invalid_key", "listing_mismatch", "keyed_only", "plan_required", "not_found", "rate_limited", "quota_spent", "budget_spent", "internal", "not_ready", "check_unavailable", "invalid_word", "disabled_in_catalog", "not_a_word", "brand", "offensive", "consumer_day_cap", "intake_day_cap", "gate_unavailable" ] } } }, "Meta": { "type": "object", "required": [ "asOf", "cursor", "limit" ], "properties": { "asOf": { "format": "date-time", "nullable": true, "type": "string" }, "cursor": { "nullable": true, "type": "string" }, "limit": { "nullable": true, "type": "integer" } }, "additionalProperties": true }, "Links": { "type": "object", "required": [ "self", "next", "register", "product", "dataset" ], "properties": { "self": { "type": "string", "format": "uri" }, "next": { "format": "uri", "nullable": true, "type": "string" }, "register": { "format": "uri", "nullable": true, "type": "string" }, "product": { "format": "uri", "nullable": true, "type": "string" }, "dataset": { "format": "uri", "nullable": true, "type": "string" } } } }, "responses": { "Problem400": { "description": "validation_failed, cursor_invalid, unsupported_field, unsupported_format", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "Problem401": { "description": "invalid_proxy_secret, invalid_key", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "Problem403": { "description": "listing_mismatch, keyed_only, plan_required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "Problem404": { "description": "not_found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "Problem429": { "description": "rate_limited, quota_spent, budget_spent, consumer_day_cap, intake_day_cap", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "Problem500": { "description": "internal", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "Problem503": { "description": "not_ready, check_unavailable, gate_unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "Problem422": { "description": "invalid_word, disabled_in_catalog, not_a_word, brand, offensive", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }