HelipodDocs

Search and prices

Check whether a domain is available and read registration, renewal and transfer prices.

Search and the price list are public: they need no API key, the same as on the Helipod website. The price detail endpoint needs a key.

Search availability

GET/domains/searchno key
Check whether a domain name can be registered.

Prop

Type

curl "https://api.helipod.io/api/domains/search?domain=example.com"
Response
{
  "success": true,
  "data": {
    "name": "example.com",
    "available": 1,
    "message": "Domain available",
    "is_premium_name": false
  }
}
FieldTypeDescription
namestringThe name that was checked.
availablenumber1 if the name can be registered, 0 if it is taken or not allowed.
messagestringShort explanation from the registry.
is_premium_namebooleantrue when the registry sells this name at a premium price.

Search answers for any extension the registry knows. Registration through Helipod is limited to the supported extensions.

List prices

GET/domains/pricesno key
Prices per extension, VAT included.

Prop

Type

curl "https://api.helipod.io/api/domains/prices?extension=.com"
Response
{
  "success": true,
  "data": {
    "data": [
      {
        "id": 12,
        "domain_extension": { "extension": ".com" },
        "currency": "IDR",
        "registration": { "1": 199000 },
        "renewal": { "1": 214000 },
        "transfer": 214000,
        "whois_protection": 20000
      }
    ],
    "meta": { "current_page": 1, "last_page": 1, "per_page": 50, "total": 1 }
  }
}

Price row

FieldTypeDescription
idnumberPrice id. Use it with price detail.
domain_extension.extensionstringThe extension, for example .com.
currencystringAlways IDR.
registrationobjectRegistration price per period. The key is the number of years ("1", "2", ...), the value is the total price.
renewalobjectRenewal price per period, same format.
transfernumberTransfer price (one year).
whois_protectionnumberWHOIS protection price per year, currently 20000 (Rp 20,000). The same amount is charged at register, renew and when you enable it later.
special_pricebooleanPresent and true when the extension has a special Helipod price. The special price applies to the one-year registration.
kemerdekaan_promobooleanPresent and true while a limited-time promotion is running for this extension.

All amounts include 11% VAT (PPN). The registration, transfer and renewal endpoints accept a one-year period only, so registration["1"] and renewal["1"] are the prices you pay.

Pagination

meta holds page numbers only:

FieldDescription
current_pageThe page returned.
last_pageThe last page. Stop when current_page equals it.
per_pageRows per page.
totalTotal number of rows.
curl "https://api.helipod.io/api/domains/prices?page=2&limit=100"

Price detail

GET/domains/prices/{priceId}
One price row by its id.

Returns a single price row in the same format as the list, with the same fields and flags. Use the id from the price list.

curl https://api.helipod.io/api/domains/prices/12 \
  -H "Authorization: Bearer hel_your_key"
Response
{
  "success": true,
  "data": {
    "id": 12,
    "domain_extension": { "extension": ".com" },
    "currency": "IDR",
    "registration": { "1": 199000 },
    "renewal": { "1": 214000 },
    "transfer": 214000,
    "whois_protection": 20000
  }
}

An unknown priceId returns 404 with code NOT_FOUND. So does a priceId that is not a number.

Errors

StatuscodeWhen
422VALIDATION_ERRORdomain is missing on search.
404NOT_FOUNDUnknown or non-numeric priceId.
502REGISTRAR_ERRORThe registry could not be reached. Retry later.

On this page