### GET /v1/discovery/tlds Source: https://api.cheapinboxes.com/docs Returns all supported top-level domains (e.g. .com, .io, .shop) with their annual registration prices. ```APIDOC ## GET /v1/discovery/tlds ### Description Returns all supported top-level domains (e.g. .com, .io, .shop) with their annual registration prices. Call this before domain search to show your users which TLDs are available and how much they cost. ### Method GET ### Endpoint /v1/discovery/tlds ### Parameters None ### Request Example ```bash curl https://api.cheapinboxes.com/v1/discovery/tlds \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN' ``` ### Response #### Success Response (200) - **tlds** (array) - A list of available TLDs with their prices. - **tld** (string) - The top-level domain. - **label** (string) - The display label for the TLD. - **price** (number) - The annual registration price. #### Response Example ```json { "tlds": [ { "tld": "com", "label": ".com", "price": 12.99 }, { "tld": "io", "label": ".io", "price": 39.99 }, { "tld": "shop", "label": ".shop", "price": 3 }, { "tld": "online", "label": ".online", "price": 3 } ] } ``` ``` -------------------------------- ### GET /v1/org Source: https://api.cheapinboxes.com/docs Get organization details. ```APIDOC ## GET /v1/org ### Description Get organization details. ### Method GET ### Endpoint /v1/org ### Parameters None ### Request Example ```bash curl -X GET "https://api.cheapinboxes.com/v1/org" \ -H "Authorization: Bearer ci_live_..." ``` ### Response #### Success Response (200) - **organization_id** (string) - The unique identifier for the organization. - **name** (string) - The name of the organization. - **created_at** (string) - The timestamp when the organization was created. #### Response Example ```json { "organization_id": "org_12345abcde", "name": "My Organization", "created_at": "2023-10-27T10:00:00Z" } ``` ``` -------------------------------- ### Send Shell Curl Request Source: https://api.cheapinboxes.com/docs Example of sending a request using curl. This is useful for testing API endpoints directly from the command line. ```shell curl ``` -------------------------------- ### List Available TLDs Source: https://api.cheapinboxes.com/docs Retrieve supported top-level domains and their annual registration prices. ```Shell curl https://api.cheapinboxes.com/v1/discovery/tlds \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN' ``` ```JSON { "tlds": [ { "tld": "com", "label": ".com", "price": 12.99 }, { "tld": "io", "label": ".io", "price": 39.99 }, { "tld": "shop", "label": ".shop", "price": 3 }, { "tld": "online", "label": ".online", "price": 3 } ] } ``` -------------------------------- ### Search for Available Domains Source: https://api.cheapinboxes.com/docs Check domain availability by keyword and retrieve suggestions across specified TLDs. ```Shell curl https://api.cheapinboxes.com/v1/discovery/domains/search \ --request POST \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \ --data '{ "additionalProperty": "anything" }' ``` ```JSON { "exact": [ { "domain": "acmeoutreach.com", "available": true, "status": "available", "price": 12.99, "currency": "USD" } ], "suggestions": [ { "domain": "acmeoutreach.io", "available": true, "status": "available", "price": 39.99, "currency": "USD" }, { "domain": "acmeleads.com", "available": true, "status": "available", "price": 12.99, "currency": "USD" } ] } ``` -------------------------------- ### POST /v1/discovery/domains/search Source: https://api.cheapinboxes.com/docs Search for domain availability by keyword. Returns an exact-match result plus creative suggestions across the requested TLDs. ```APIDOC ## POST /v1/discovery/domains/search ### Description Search for domain availability by keyword. Returns an exact-match result plus creative suggestions across the requested TLDs. This is the first step of the domain purchase flow — use it to let users find and pick domains before placing an order. Pass `keyword` (string) and `tlds` (array of TLD strings) in the body. ### Method POST ### Endpoint /v1/discovery/domains/search ### Parameters #### Request Body - **keyword** (string) - Required - The keyword to search for. - **tlds** (array of strings) - Required - An array of TLD strings to search within. ### Request Example ```bash curl https://api.cheapinboxes.com/v1/discovery/domains/search \ --request POST \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \ --data '{ "keyword": "example", "tlds": ["com", "io"] }' ``` ### Response #### Success Response (200) - **exact** (array) - Exact match results. - **domain** (string) - The domain name. - **available** (boolean) - Whether the domain is available. - **status** (string) - The availability status. - **price** (number) - The price of the domain. - **currency** (string) - The currency of the price. - **suggestions** (array) - Suggested domain names. - **domain** (string) - The domain name. - **available** (boolean) - Whether the domain is available. - **status** (string) - The availability status. - **price** (number) - The price of the domain. - **currency** (string) - The currency of the price. #### Response Example ```json { "exact": [ { "domain": "acmeoutreach.com", "available": true, "status": "available", "price": 12.99, "currency": "USD" } ], "suggestions": [ { "domain": "acmeoutreach.io", "available": true, "status": "available", "price": 39.99, "currency": "USD" }, { "domain": "acmeleads.com", "available": true, "status": "available", "price": 12.99, "currency": "USD" } ] } ``` ``` -------------------------------- ### Authentication Source: https://api.cheapinboxes.com/docs Every request must include your API key as a Bearer token in the Authorization header. ```APIDOC ## Authentication Every request must include your API key as a Bearer token: ``` Authorization: Bearer ci_live_... ``` API keys are scoped to a single organization. Create and manage them from the Cheap Inboxes dashboard under **Integrations → API**. Treat keys like passwords — store them in environment variables, never commit them to source control. ``` -------------------------------- ### Rate Limits Source: https://api.cheapinboxes.com/docs All endpoints are rate-limited to 120 requests per minute per API key. Response headers include rate limit information. ```APIDOC ## Rate Limits All endpoints are rate-limited to **120 requests per minute** per API key. Response headers include `X-RateLimit-Limit`, `X-RateLimit-Remaining`, and `X-RateLimit-Reset` so you can throttle proactively. ``` -------------------------------- ### Authenticate API Requests Source: https://api.cheapinboxes.com/docs Include the API key in the Authorization header as a Bearer token for all requests. ```HTTP Authorization: Bearer ci_live_... ``` -------------------------------- ### Errors Source: https://api.cheapinboxes.com/docs Errors return a consistent JSON envelope with a code and message. ```APIDOC ## Errors Errors return a consistent JSON envelope: ```json { "error": { "code": "VALIDATION_ERROR", "message": "..." } } ``` Common codes: `VALIDATION_ERROR` (400), `UNAUTHORIZED` (401), `NOT_FOUND` (404), `RATE_LIMIT_EXCEEDED` (429), `INTERNAL_ERROR` (500). ``` -------------------------------- ### Handle API Error Responses Source: https://api.cheapinboxes.com/docs Errors are returned in a standard JSON format containing a code and message. ```JSON { "error": { "code": "VALIDATION_ERROR", "message": "..." } } ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.