{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"1f40a4ce-0028-48ce-bd6d-36496d713b8e","name":"Name.am API","description":"This is a Postman collection for the Name.am API — register and manage domains and hosting programmatically over a simple REST API.\n\nWhether you’re a startup or an entrepreneur, learn how to integrate Name.am into your site and manage your business online. Questions? Reach us on the [community forum](https://t.me/name_am).\n\nAll requests and responses are JSON over HTTPS. Base URL: **https://api.name.am**\n\n### Getting Started\n\n1. **Get an API token** — sign in to your dashboard → **Settings → API Keys** → create a key. It looks like `nk_live_…` and is shown once, so store it securely.\n2. **Authenticate every request** with it on the `Authorization` header:\n   `Authorization: Bearer {{token}}` — set the `token` environment variable to your API token once, and every request in this collection sends it.\n3. **Check availability & price** — `POST /client/domains/check`.\n4. **Register / renew / transfer** a domain, or **buy hosting** — `POST /client/carts/purchase`. Orders are charged to your **account balance**.\n5. **Manage** — list your domains (`GET /client/domains`) and update contacts, nameservers, DNS records, DNSSEC, auto-renew and transfer lock via `PUT /client/domains/{domain}`.\n\n### Authentication\n\nAll requests are authenticated with an **API token**. Create one in your dashboard under **Settings → API Keys** — the token (`nk_live_…`) is shown once, so store it securely.\n\nSend it on the `Authorization` header of every request:\n\n```bash\ncurl https://api.name.am/client/domains \\\n  -H \"Authorization: Bearer {{token}}\"\n```\n\nIn Postman, `{{token}}` resolves from your environment; in your own code, use your `nk_live_…` token as the credential after `Bearer`. The same header works across the whole API. Purchases are charged to your **account balance**. For security, an API token **cannot** perform account-security actions (saved cards, two-factor, password change, session management) — those require signing in to your dashboard.\n\nAlready calling `POST /auth/login` on every request? Replace it with a single API token in the `Authorization` header — nothing else changes.\n\n### Errors\n\nErrors return a JSON body with a `message` field and a matching HTTP status:\n\n```json\n{ \"message\": \"Unauthorized\" }\n```\n\n| Status | Meaning |\n| :-- | :-- |\n| `200` | Success |\n| `400` | Invalid request — validation failed (e.g. bad nameservers or contact info) |\n| `401` | Missing or invalid API token |\n| `403` | Action not available with an API token (account-security endpoints) |\n| `404` | Resource not found (e.g. a domain not in your account) |\n| `500` | Unexpected server error |\n\nNote: a purchase with insufficient balance is **not** an error — it returns a transaction with `\"status\": \"failed\"`.\n\n### Environment\nThis collection uses one environment variable:\n\n|Name|Description|\n| :-- | :-- |\n| `token`| Your API token (`nk_live_…`) |","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":true,"owner":"1966919","team":9839271,"collectionId":"1f40a4ce-0028-48ce-bd6d-36496d713b8e","publishedId":"Szzj8dJx","public":true,"publicUrl":"https://docs.name.am","privateUrl":"https://go.postman.co/documentation/1966919-1f40a4ce-0028-48ce-bd6d-36496d713b8e","customColor":{"top-bar":"FFFFFF","right-sidebar":"182430","highlight":"0086FF"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.12.3","publishDate":"2020-08-20T12:12:07.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/79fc4ced28fcb5ec4847b085bbc2710f74b2b3ced98d1234652ae66cade12644","favicon":"https://res.cloudinary.com/postman/image/upload/v1592301506/team/puqrrmsmkwcd5bn1qnlq.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://docs.name.am/view/metadata/Szzj8dJx"}