{ "openapi": "3.0.1", "info": { "title": "Brand & Username Availability Checker", "description": "Checks a brand name or handle across 9 social platforms and any domain extension in a single run, and tells you exactly where it is still free.", "version": "0.1", "x-build-id": "7clj9bCNNu35E7eni" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/maged120~brand-username-checker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-maged120-brand-username-checker", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/maged120~brand-username-checker/runs": { "post": { "operationId": "runs-sync-maged120-brand-username-checker", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/maged120~brand-username-checker/run-sync": { "post": { "operationId": "run-sync-maged120-brand-username-checker", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "names" ], "properties": { "names": { "title": "Names to Check", "type": "array", "description": "The brand names or handles you want to check. Paste a bare name, an @handle, or a profile URL — all are accepted. Each name is checked against every platform and domain extension you select below.", "items": { "type": "string" } }, "platforms": { "title": "Platforms", "type": "array", "description": "Which platforms to check each name against. Every platform you select is one result per name.", "items": { "type": "string", "enum": [ "instagram", "x", "tiktok", "youtube", "snapchat", "pinterest", "twitch", "discord", "github" ], "enumTitles": [ "Instagram", "X (Twitter)", "TikTok", "YouTube", "Snapchat", "Pinterest", "Twitch", "Discord", "GitHub" ] }, "default": [ "instagram", "x", "tiktok", "youtube", "snapchat", "pinterest", "twitch", "discord", "github" ] }, "checkDomains": { "title": "Check Domain Names", "type": "boolean", "description": "Also check whether the matching domain names are registered. Turn this off to check social handles only.", "default": true }, "domainTlds": { "title": "Domain Extensions", "type": "array", "description": "Which domain extensions to check for each name. Each extension is one result per name. Ignored when domain checking is turned off.", "items": { "type": "string", "enum": [ "com", "net", "org", "io", "co", "ai", "app", "dev", "shop", "store", "xyz", "me", "online", "site", "tech" ], "enumTitles": [ ".com", ".net", ".org", ".io", ".co", ".ai", ".app", ".dev", ".shop", ".store", ".xyz", ".me", ".online", ".site", ".tech" ] }, "default": [ "com", "net", "org", "io", "co" ] }, "includeSummary": { "title": "Include Summary Row", "type": "boolean", "description": "Add one summary result per name listing where it is free and where it is taken. Handy for ranking a shortlist of candidate names.", "default": true }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Optional proxy settings. Not required for normal use — enable only if you check very large name lists and start seeing rate limiting.", "default": { "useApifyProxy": false } } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } }