Documentation for domai.io's API. You can request API access here.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"33105161","collectionId":"a24d35f7-009d-4196-bf9e-bd74d0ec056c","publishedId":"2sA2xb7GNd","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"4b5de4"},"publishDate":"2024-03-03T17:09:54.000Z"},"item":[{"name":"Account","item":[{"name":"Get token","id":"d9b6005d-4687-433a-8031-d551e582934d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"username","value":"(required)
\n","type":"text"},{"key":"password","value":"(required)
\n","type":"text"}]},"url":"https://api.domai.io/account/get-token/","description":"Generates a token which will be required for Suggestions functions. Use the username and password you obtained from your administrator.
\n","urlObject":{"protocol":"https","path":["account","get-token",""],"host":["api","domai","io"],"query":[],"variable":[]}},"response":[{"id":"d76f3a10-78ba-47d4-b983-b89a1fa5db52","name":"Get token","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"username","value":"(required) API bearer token - use get-token endpoint to generate
\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"supported_TLDs","value":"(optional) List of available TLDs in JSON array format: [\".TLD1\",\".TLD2\"]. If this parameter is ignored, the list of supported TLDs will be set to default.
\n"}]},"url":"https://api.domai.io/account/supported-TLDs/","description":"Set and update the list of TLDs which you support. We will use that list to restrict generated domain names to the TLDs you support. By default all the TLDs are included in the suggestions.
\nWARNING: Any changes to the list of available TLDs is immediate. Ensure you are using the right list before making changes.
\n","urlObject":{"protocol":"https","path":["account","supported-TLDs",""],"host":["api","domai","io"],"query":[],"variable":[]}},"response":[{"id":"f891e92a-bf12-42b3-8700-8aa7497d0b2f","name":"Set TLD availability","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Token(required) API bearer token - use get-token endpoint to generate
\n","type":"text"}],"url":"https://api.domai.io/account/supported-TLDs/","description":"See the list of your supported TLDs. Use this endpoint if you'd like to confirm which TLDs you support for domain suggestions. Use a PUT request to amend the list of supported TLDs (see above).
\n","urlObject":{"protocol":"https","path":["account","supported-TLDs",""],"host":["api","domai","io"],"query":[],"variable":[]}},"response":[{"id":"8661121a-9dd7-4218-b58d-51a753e6b232","name":"See supported TLDs","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"TokenYou wil need to request a username and password from your administrator. Once obtained, you can generate a bearer token to use the API.
\n","_postman_id":"7774f4be-b4d2-417a-ad3f-fd559379ed4b"},{"name":"Intelligence","item":[{"name":"Domain suggestions","item":[{"name":"suggest","id":"48e5dd4e-d24e-4cec-9de3-812835ba3010","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token(required) API bearer token - use get-token endpoint to generate
\n","type":"text"}],"url":"https://api.domai.io/intelligence/suggest/?query=This endpoint returns domain name suggestions.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"96eef499-1073-465a-ad8e-a9bf11e5006c","id":"96eef499-1073-465a-ad8e-a9bf11e5006c","name":"Intelligence","type":"folder"}},"urlObject":{"protocol":"https","path":["intelligence","suggest",""],"host":["api","domai","io"],"query":[{"description":{"content":"(required) domain name or business/project description
\n","type":"text/plain"},"key":"query","value":"(optional) specify TLDs to imperatively include in suggestions (e.g. {\".xyz\": 2, \".cfd\":1} will return the first two domains with .xyz and the third domain with .cfd). This hard requirement may increase response time however.\nYou may include \"ccTLD\" as a key if you'd like to return a set number of the locally-relevant ccTLD based on the user's IP address (e.g. {\"ccTLD\": 2, \".xyz\": 2} will return the first two domains with .fr for a France-based user, and the third and fourth domains with .xyz).
\nOr specify TLDs you'd like to prioritise (e.g. [\".xyz\", \".cfd\"]) - this will just increase the likelihood of these TLDs being included in the suggestions. The locally relevant ccTLD is automatically passed if you use the clientIP parameter.
\n","type":"text/plain"},"key":"TLDpreference","value":"(optional) style of suggestions - random, alliteration, metaphore, twoword, misspelled, ify
\n","type":"text/plain"},"key":"style","value":"