API v1 Documentatie

Informatie over ondersteunde methoden, parameters, geretourneerde gegevens en voorbeelden.

Waarschuwing: De API is momenteel in ontwikkeling en er kunnen functies worden toegevoegd: in de toekomst kunnen nieuwe methoden en parameters worden toegevoegd. Eventuele wijzigingen blijven achterwaarts compatibel met bestaande functionaliteit.

Overzicht

De TLD-List v1 API kan gebruikt worden om gegevens die weergegeven worden op TLD-List op te halen uit de live database.

De API accepteert HTTP POSTs die JSON data bevatten en antwoordt met JSON data. Vereisten voor alle API methode requests:

  • Verzoeken moeten worden gedaan met de HTTP POST-methode
  • Verzoeken moeten een JSON body bevatten met een geldig openbaar en privé API sleutelpaar voor verificatie
  • Verzoeken moeten de header bevatten: Inhoud-Type: toepassing/json

Parameters worden aan de API doorgegeven als sleutel/waarden in de JSON gecodeerde verzoek body.

De basis URL voor alle API verzoeken is:

https://api.tld-list.com/v1

Authenticatie

Authenticatie wordt uitgevoerd door het doorgeven van een publieke API sleutel en een privé API sleutel in de JSON body die naar de methode URL is gestuurd. Alle API-aanroepen moeten een geldig API sleutelpaar bevatten. API sleutelparen kunnen worden gegenereerd in uw TLD-List account onder het tabblad API.

Ga naar Account > API om API-sleutels aan te maken.

API-sleutels worden doorgegeven in de JSON request body met behulp van de parameters apiKeyPublic ( uw openbare sleutel) en apiKeyPrivate ( uw privésleutel).

Example authentication parameters

{
    "apiKeyPublic":"MY_PUBLIC_KEY",
    "apiKeyPrivate":"MY_PRIVATE_KEY" 
}

Reactie

Alle succesvolle API antwoorden hebben een 200 SUCCESS HTTP status code en een JSON gecodeerde body. Elke andere HTTP-statuscode in het antwoord geeft aan dat het verzoek is mislukt en dat er een fout is opgetreden.

JSON antwoordobjecten die door de API worden geretourneerd, hebben de volgende structuur:

Sleutel Type Beschrijving
status string Geeft de status van het verzoek aan. SUCCESS geeft aan dat de API-aanroep succesvol was, FAIL geeft aan dat het verzoek is mislukt.
errors array of objects Array van objecten die de opgetreden fouten vertegenwoordigen. Elk foutobject bevat:

code: tekenreeks die het type fout aangeeft

bericht: menselijk leesbare tekenreeks die de fout beschrijft

parameter: optionele tekenreeks of matrix van tekenreeksen die een probleem met een bepaalde in het verzoek doorgegeven parameter(s) aangeeft.

Als er geen fouten zijn opgetreden, zal de fouten-array leeg zijn.

Zie Foutcodes voor meer informatie.
seconds number De tijd die de API server nodig had om een antwoord te genereren (in seconden).
data string|array|object Een object, matrix of tekenreeks die de gevraagde gegevens bevat.

Voorbeeld van een mislukt antwoordobject met fouten

{
   "errors" : [
      {
         "code" : "PARAMETER_INVALID",
         "message" : "pricetypes parameter must be a non-empty array",
         "parameter" : "pricetypes"
      },
      {
         "code" : "PARAMETER_INVALID",
         "message" : "includeRegistrars parameter contains invalid registrar names: foobar",
         "parameter" : "includeRegistrars"
      }
   ],
   "seconds" : 0.001,
   "status" : "FAIL"
}

Voorbeeld van een geslaagd antwoordobject

{
   "data" : [
      {
         "cheapest" : {
            "renewal" : [
               {
                  "id" : "sav",
                  "name" : "Sav",
                  "price" : "8.38"
               }
            ],
         },
         "currency" : "USD",
         "name" : "com",
         "registrarsIncluded" : 58,
         "registrarsTotal" : 58
      }
   ],
   "errors" : [],
   "seconds" : 0.001,
   "status" : "SUCCESS"
}

Gemeenschappelijke antwoordobjecten

Sommige API methoden retourneren dataobjecten die dezelfde structuur hebben. Deze algemene dataobjecten worden hieronder in detail beschreven.

RegistrarPricing

Beschrijft de detailhandelsprijzen van een registrar voor een extensie voor een bepaald prijstype (register, renewal, transfer), inclusief extra details zoals speciale voorwaarden, kosten, belasting en promoties.

Pad Type Beschrijving
id string Registrar ID-string die de registratiehouder op unieke wijze identificeert.
name string Weergavenaam van registratiehouder.
price string De uiteindelijke detailhandelsprijs van de registratiehouder voor de extensie en het prijstype.

Opmerking: dit veld is alleen aanwezig wanneer het object RegistrarPricing genest is in de context van een prijstype (bijvoorbeeld in het antwoord van getCheapestRegistrars).
priceOriginal string De reguliere verkoopprijs van de registrar voor de extensie als numerieke tekenreeks. Dit veld is alleen aanwezig als de prijs een actieprijs is.

Opmerking: dit veld is alleen aanwezig wanneer het object RegistrarPricing genest is in de context van een prijstype (bijvoorbeeld in het antwoord van getCheapestRegistrars).
pricetype string Het type van de extensieprijsstelling, een van: register, renewal, transfer.

Opmerking: dit veld is alleen aanwezig wanneer het object RegistrarPricing genest is in de context van een prijstype (bijvoorbeeld in het antwoord van getCheapestRegistrars).
prices object De detailhandelsprijs van de registrar voor de extensie voor alle prijscategorieën.
prices[pricetype] string De uiteindelijke verkoopprijs van de registrar voor de extensie en [pricetype], waarbij de sleutel [pricetype] register, renewal, transfer, restore, whoisprivacy is. Voorbeeld:

{
    "register": "8.73",
    "renewal": "9.73",
    "transfer": "9.73",
    "whoisPrivacy": "0.00"
}
pricesOriginal object De reguliere detailhandelsprijzen van de registratiehouder voor de extensie voor alle prijstypes. Dit veld is niet aanwezig als de registratiehouder geen actieve promo's heeft.
pricesOriginal[pricetype] string De reguliere verkoopprijs van de registrar voor de extensie en [prijstype], waarbij de sleutel [prijstype] register, renewal, transfer, restore, whoisprivacy is.
promo object Een RegistrarPromo-object dat promotieprijzen weergeeft die zijn toegepast op de prijs van de registratiehouder voor deze extensie en dit prijstype. Als er geen promo is toegepast, is dit veld niet aanwezig. Voorbeeldpromo-object:

{
    "code": "MYCOUPONCODE",
    "amount": "20.00",
    "type": "discount-percent",
    "start": "2015-06-22T00:00:00",
    "end": "2025-06-22T00:00:00"
}


Opmerking: dit veld is alleen aanwezig wanneer het object RegistrarPricing genest is in de context van een prijstype (bijvoorbeeld in het antwoord van getCheapestRegistrars).
promos array of objects Array van objecten RegistrarPromo die alle actieve promotieprijzen vertegenwoordigt die door de registratiehouder voor deze extensie worden aangeboden.
terms object Een verzameling objecten die speciale voorwaarden vertegenwoordigen die van toepassing zijn op de prijzen van de registratiehouder. Als er geen speciale voorwaarden van toepassing zijn, is dit veld niet aanwezig. Elk subobject heeft een term-ID als sleutel:

limitPerCustomer - specificeert dat de prijs alleen geldig is voor een bepaald aantal domeinen per klant.
newCustomerOnly - specificeert dat de prijs alleen geldig is voor nieuwe klanten.
affiliateLink - specificeert dat de prijs alleen geldig is wanneer de klant via een affiliate-link naar de site van de registrar gaat.
nameserverLockIn - specificeert dat gekochte domeinen alleen de nameservers van de registratiehouder kunnen gebruiken.
idSubmissionRequired - specificeert dat de klant zijn/haar foto-ID of bedrijfsregistratie moet indienen om een aankoop te voltooien.

Voorbeeldvoorwaardenobjecten:

{
    "limitPerCustomer": {
        "pricetype": [
            "register"
        ],
        "count": 1
    },
    "newCustomerOnly": {
        "pricetype": [
            "register"
        ]
    },
    "affiliateLink": {
        "pricetype": [
            "register"
        ]
    },
    "multiYearPurchaseRequired": {
        "pricetype": [
            "register"
        ],
        "count": 2
    },
    "nameserverLockIn": {
        "pricetype": [
            "register",
            "renewal",
            "transfer"
        ]
    },
    "idSubmissionRequired": {
        "pricetype": [
            "register",
            "renewal",
            "transfer"
        ]
    }
}
terms[term].count number De hoeveelheid waartoe de term de klant beperkt. Bijvoorbeeld, als aantal = 1, dan is de klant beperkt tot 1 domein tegen de opgegeven prijs. Dit veld is niet aanwezig als het niet van toepassing is.
terms[term].pricetype array of strings De prijstype(n) waarop de term van toepassing is: register, renewal, transfer. Dit veld is alleen aanwezig als het prijstype van het object RegistrarPricing niet gespecificeerd is.
notes object Een verzameling objecten die notities vertegenwoordigen die betrekking hebben op de prijsstelling van de registratiehouder. Als er geen prijsnotities zijn, is deze waarde een leeg object. Elk subobject heeft een biljetten-ID als sleutel: currencyExchangeRate, feeIcann, feeTax, feePayment
notes.feeIcann object Geeft aan of er een ICANN-vergoeding is toegevoegd aan de uiteindelijke prijs voor het TLD (meestal $0,18 USD). Als deze opmerking bestaat, betekent dit dat de registrar de ICANN-vergoeding niet in de geadverteerde prijs opneemt, maar deze in plaats daarvan toevoegt als een extra vergoeding aan de TLD's prijs bij het afrekenen met de klant.

Voorbeeld fee_icann notitie-object:

{
    "feeIcann": {
        "pricetype": [
            "register",
            "renewal",
            "transfer"
        ],
        "amount": "0.18",
        "addedToListPrice": true
    }
}

Het veld pricetype specificeert welke prijstypes onderhevig zijn aan de vergoeding, en het veld addedToListPrice geeft aan dat de vergoeding is toegevoegd aan de uiteindelijke prijs.
notes.feeTax array of objects Specificeert de verschillende belastingtarieven die door een registrar in rekening worden gebracht, op welke klanten de belasting van toepassing is en of de berekende belasting in de uiteindelijke prijs voor de TLD is inbegrepen. Houd er rekening mee dat belastingen alleen in de uiteindelijke prijs voor het TLD zijn inbegrepen als de registratiehouder de belasting niet in zijn geadverteerde prijzen opneemt en de belasting aan alle klanten in rekening wordt gebracht.

Voorbeeld feeTax matrix van objecten:

{
    "feeTax": [
        {
            "addedToListPrice": false,
            "appliesToCustomers": [
                "eu",
                "us",
                "in"
            ],
            "amountRateType": "percent",
            "amountRate": "13",
            "type": "hst"
        },
        {
            "addedToListPrice": false,
            "appliesToCustomers": [
                "ca"
            ],
            "amountRateType": "percent",
            "amountRate": "5",
            "type": "gst"
        }
    ]
}
notes.feeTax[].type string Label dat het type belasting beschrijft, bijv. "btw" voor Belasting op de Toegevoegde Waarde, "gst" voor Belasting op Goederen en Diensten, enz.
notes.feeTax[].amountRate number|string Bedrag belastingtarief. Dit is ofwel het belastingpercentage als getal, of de tekenreeks "~" die aangeeft dat het belastingtarief varieert op basis van klantcriteria, zoals locatie.
notes.feeTax[].amountRateType string De tekenreekswaarde "percent" geeft aan dat de amountRate-waarde een numeriek percentage is. De tekenreekswaarde "percent-varies-by-location" geeft aan dat het belastingtarief varieert op basis van de factureringsregio of het land van de klant.
notes.feeTax[].appliesToCustomers string|array of strings de tekenreeks "*" geeft aan dat de belasting voor alle klanten geldt. Anders is deze waarde een array van ISO 3166-1 alpha-2 landcodestrings die definiëren welke landen onderhevig zijn aan de belasting. Een uitzondering om op te merken: de matrix kan de niet-landcodestring "eu" bevatten, die alle landen in de Europese Unie vertegenwoordigt.
notes.feeTax[].addedToListPrice boolean Geeft aan of het berekende belastingbedrag is toegevoegd aan de uiteindelijke prijs.
notes.feePayment object Geeft aan of de registrar een extra vergoeding in rekening brengt op basis van de betalingsmethode van de klant, en of de vergoeding is opgenomen in de uiteindelijke prijs voor het TLD.
Voorbeeld feePayment-object:

{
    "feePayment": {
        "addedToListPrice": false,
        "amountRate": "~",
        "amountRateMin": "0.9",
        "amountRateMax": "20",
        "amountRateType": "percent-varies-by-method"
    }
}
notes.feePayment.amountRate string Bedrag van de vergoeding. Dit is ofwel het percentage van de vergoeding als een getal, of de tekenreeks "~" die aangeeft dat het percentage van de vergoeding varieert op basis van criteria van de klant, zoals de betalingsmethode.
notes.feePayment.amountRateMin string Minimumvergoeding, alleen van toepassing als de vergoeding variabel is.
notes.feePayment.amountRateMax string Maximumbedrag van de vergoeding, geldt alleen als de vergoeding variabel is.
notes.feePayment.amountRateType string De tekenreekswaarde "percent" geeft aan dat de amountRate-waarde een numeriek percentage is. De tekenreekswaarde "percent-varies-by-method" geeft aan dat het bedrag een percentage is dat varieert op basis van de betalingsmethode van de klant.
notes.feePayment.addedToListPrice boolean Geeft aan of het berekende bedrag aan kosten is toegevoegd aan de uiteindelijke prijs.
notes.currencyExchangeRate object Geeft aan dat de prijzen van de registratiehouder in een andere nationale valuta waren genoteerd en zijn omgezet naar USD. De details van de valutaconversie worden weergegeven als:

basis: de prijsvaluta van de registratiehouder als een 3-lettercode (bijv. EUR)
quote: de valuta waarnaar de prijzen zijn geconverteerd (is altijd USD)
koers: de wisselkoers die is gebruikt voor de valutaconversie.

Voorbeeld currencyExchangeRate notitieobject:

{
    "currencyExchangeRate": {
        "base": "GBP",
        "quote": "USD",
        "rate": "1.2482"
    }
}
threeYearValueScore number Een numerieke meting van de waarde, bepaald door de prijs en gratis functies, voor het bezitten van een domein met deze extensie via de registrar voor een periode van 3 jaar. Hoe groter het getal, hoe meer waarde er wordt geboden.
currency string De ISO 4217 valutacode van drie letters van de prijsgegevens. Deze waarde is momenteel alleen USD.
freeFeatures array of objects Een matrix van objecten die de gratis functies vertegenwoordigen die de registrar aanbiedt bij domeineigendom. Het object bevat de hoeveelheid en duur van elke functie. Elk object is voorzien van een gratis kenmerk-ID:

dns - gratis DNS-service.
whois-privacy - WHOIS-privacy-service.
email-account - gratis e-mailaccount(s).
email-forward - gratis e-mail doorsturen.
ssl-cert - gratis basis SSL-certificaat (certificaten).

Voorbeeld van gratis kenmerk-array:

[
    {
        "name": "dns"
    },
    {
        "name": "whois-privacy"
    },
    {
        "name": "email-account",
        "count": 5
    },
    {
        "name": "ssl-cert",
        "duration": 365
    }
]
freeFeatures[].count number De hoeveelheid van de functie die de registratiehouder gratis aanbiedt. Dit veld is niet aanwezig als het niet van toepassing is.
freeFeatures[].duration number Het aantal dagen dat de functie gratis wordt aangeboden door de registratiehouder. Als de duur = 365, dan wordt de functie 1 jaar gratis aangeboden. Dit veld is niet aanwezig als het niet van toepassing is.

RegistrarPromo

Beschrijft een actieve promotie die door een registrar wordt aangeboden. Voorbeeld:

{
    "code": "MYCOUPONCODE",
    "amount": "20.00",
    "type": "discount-percent",
    "start": "2015-06-22T00:00:00",
    "end": "2025-06-22T00:00:00"
}
Pad Type Beschrijving
promo.code string De promotiecode die de klant bij het afrekenen moet invoeren om de korting te ontvangen.
promo.amount string Het numerieke bedrag van de promotieprijs. Afhankelijk van het type promo kan dit de gereduceerde prijs(price), het bedrag dat van de normale prijs(discount), of het percentagebedrag dat van de normale prijs(discount-percent) wordt afgetrokken zijn.
promo.type string Een tekenreeks die het type promotieprijs weergeeft. Zal een van de volgende waarden hebben:

prijs - betekent dat het bedragveld van de promo de nieuwe gereduceerde prijs is
korting - betekent dat het bedragveld van de promo van de normale prijs werd afgetrokken om de toegepaste prijs te verkrijgen
korting-percentage - betekent dat het bedragveld van de promo een percentage is, en het percentage werd van de normale prijs afgetrokken om de toegepaste prijs te verkrijgen.
promo.start string ISO 8601 datetime (UTC-tijdzone) van wanneer de promo gestart is. Zal niet aanwezig zijn als er geen specifieke begindatum was. Voorbeeld: 2015-06-22T00:00:00
promo.end string ISO 8601 datetime (UTC tijdzone) van wanneer de promo zal eindigen. Wordt niet weergegeven als er geen specifieke einddatum is. Voorbeeld: 2025-06-22T00:00:00
promo.pricetype array of strings De prijstype(n) waarop de promo van toepassing is: register, renewal, transfer.

Opmerking: dit veld is alleen aanwezig wanneer het genest is in de context van een prijstype (bijvoorbeeld in het antwoord van getCheapestRegistrars).

Foutcodes

Als een verzoek mislukt, kan het JSON antwoordobject een of meer foutobjecten bevatten die beschrijven wat er fout ging. Hieronder vindt u een niet-complete lijst met identificerende foutcodes die kunnen worden ingesteld in het codeveld van het foutobject.

Code Beschrijving
502 API-server is tijdelijk niet beschikbaar.
RATE_LIMITED Aantal API-verzoeken van client overschreden toegestaan maximum.
INVALID_METHOD De aangevraagde API methode bestaat niet.
SYSTEM Er is een onbekende systeemfout opgetreden.
RESPONSE_TIMEOUT De API-server is uitgetimed tijdens het genereren van een antwoord.
PARAMETER_REQUIRED Een vereiste parameter voor de aangeroepen methode is niet opgegeven door de client.
ACCOUNT_INACTIVE De account van de klant is niet langer actief en een vernieuwing van het abonnement is vereist voor API-toegang.
NO_ACCESS Het accountniveau van de klant geeft geen API-toegang. Een accountupgrade is vereist voor API-toegang.
AUTH_INVALID Authenticatie mislukt: de geleverde API-sleutels zijn inactief of ongeldig.
CLIENT_IPS_EXCEEDED Het maximum aantal unieke IP's van clients die toegang hebben tot de API voor het API sleutelpaar is overschreden.
REQUEST_ENDED_BY_CLIENT Het verzoek werd door de client beëindigd voordat een antwoord kon worden gegenereerd.

Grenzen

Het gebruik van de API is onderworpen aan bepaalde beperkingen om misbruik te voorkomen. Deze gebruiksbeperkingen worden hieronder weergegeven en kunnen zonder kennisgeving worden gewijzigd.

Type Beschrijving
API-sleutels per account 3
Tarieflimiet 100 maximale aanvragen per 15 minuten
IP-adressen van clients per API-sleutel 5 unieke client IP-adressen per sleutel per 1440 minuten

Uitbreidingsmethoden

get

Retourneert extensies en hun bijbehorende prijs- en detailgegevens. Deze methode is verwant aan het ophalen van de gegevens die worden weergegeven op een of meer TLD-detailpagina's (bijvoorbeeld .com), met uitzondering van de gegevens over de "Goedkoopste prijsgeschiedenis", die niet worden geretourneerd door deze methode (zie de methode getAggregateHistory voor historische gegevens).

API eindpunt:https://api.tld-list.com/v1/extension/get

Reactietijd:~12 seconds for all extensions, ~6 seconds < 2000 extensions, ~2 seconds < 100 extensions

Aanvraagparameters

Sleutel Type Vereist Beschrijving
extensions array of strings

Specificeert welke extensies moeten worden opgehaald. Voeg geen punt toe. Extensienamen kunnen unicode of hun punycode-equivalent zijn. Als dit wordt weggelaten, worden alle extensies op TLD-List geretourneerd.

Voorbeeld: "extensions": ["com", "io", "co.uk", "移动", "xn--p1ai"]

includeFields array of strings Specificeer bepaalde gegevens om te retourneren per sleutelnaam. Sleutels die niet in deze parameter worden opgegeven, worden weggelaten. Standaard worden alle beschikbare velden geretourneerd. Zie de responstabel voor een lijst met beschikbare velden. Geneste velden worden niet ondersteund.

Voorbeeld: "includeFields": ["name", "registrars", "dnssecSupported"]

excludeFields array of strings Specificeer de uit te sluiten cetaingegevens op basis van de sleutelnaam. Sleutels die in deze parameter worden opgegeven, worden weggelaten. Standaard worden geen velden uitgesloten. Zie de responstabel voor een lijst met beschikbare velden. Geneste velden worden niet ondersteund.

Voorbeeld: "excludeFields": ["available", "syntax", "sponsor"]

includeRegistrars array of strings

De ID's van actieve registratiehouders die in de resultaten moeten worden opgenomen. Gebruik de methode getIds om een lijst met ID's van alle actieve registratiehouders op TLD-List te verkrijgen.

Voorbeeld: "includeRegistrars": ["godaddy", "porkbun", "namecheap"]

excludeRegistrars array of strings

De string ID's van actieve registratiehouders om uit te sluiten in de resultaten. Gebruik de methode getIds om een lijst met ID's van alle actieve registratiehouders op TLD-List te verkrijgen.

Voorbeeld: "excludeRegistrars": ["godaddy", "porkbun", "namecheap"]

omitExtensionsWithoutRegistrars boolean

Als dit waar is, worden extensies die geen prijsgegevens van een registrar in de resultaten hebben, weggelaten. Standaard worden alle extensies opgenomen.

Voorbeeld: "omitExtensionsWithoutRegistrars": true

Antwoordobject

Pad Type Beschrijving
data array of objects Array van uitbreidingsnamen.
data[].available object Object van TLD-fase beschikbaarheidsdata.
data[].available.general object ISO 8601 datetime (UTC tijdzone) van wanneer domeinregistratie beschikbaar is voor het algemene publiek.
data[].available.sunrise object Object van begin- en einddatumbereiken die de Sunrise-fase van TLD's vertegenwoordigen (wanneer eigenaars van handelsmerken kunnen beginnen met het aanvragen van de registratie van toepasselijke domeinen). Voorbeeld:

{
    "sunrise": {
        "start": "2017-06-19T00:00:00.000Z",
        "end": "2017-08-21T00:00:00.000Z"
    }
}
data[].available.trademark object Object van begin- en einddatabereiken die de TLD's handelsmerkfase vertegenwoordigen (periode waarin houders van handelsmerken door het Trademark Clearinghouse op de hoogte worden gesteld als een domein met hun merk overeenkomt). Voorbeeld:

{
    "trademark": {
        "start": "2019-06-18T00:00:00.000Z",
        "end": "2020-09-21T00:00:00.000Z"
    }
}
data[].available.other array of objects Array van objecten die verschillende lanceringsfasen van de TLD vertegenwoordigen en hun datumbereik, zoals "Land Rush" en "Qualified Launch Program". Voorbeeld:

{
    "other": [
        {
            "end": "2020-09-18T00:00:00.000Z",
            "name": "Limited Community Priority Period",
            "start": "2019-09-17T00:00:00.000Z",
            "type": "limited-registration-period"
        },
        {
            "end": "2018-07-03T00:00:00.000Z",
            "name": "Restricted Land Rush 1",
            "start": "2017-10-23T00:00:00.000Z",
            "type": "limited-registration-period"
        },
        {
            "end": "2019-09-16T00:00:00.000Z",
            "name": "Invitation Priority Access",
            "start": "2017-08-22T00:00:00.000Z",
            "type": "limited-registration-period"
        },
        {
            "end": "2017-08-21T00:00:00.000Z",
            "name": "Qualified Launch Program",
            "start": "2017-06-19T00:00:00.000Z",
            "type": "qualified-launch-program"
        }
    ]
}
data[].average object Object met de gemiddelde prijs van de extensie, per prijstype, voor de opgenomen registratiehouders. Voorbeeld:

{
    "average": {
        "register": "7.63",
        "renewal": "13.63",
        "transfer": "9.63"
    }
}
data[].average[pricetype] string De gemiddelde prijs van de extensie als een numerieke tekenreeks voor [pricetype], waarbij de [pricetype] sleutel register, renewal, transfer, restore, whoisprivacy is.
data[].category string De categorieën waarin het TLD is ingedeeld. Elk object in de array vertegenwoordigt een categorie en bevat de volgende velden:

id - integer categorie-ID dat intern door TLD-List wordt gebruikt.
idstr - alternatieve string categorie-ID.
name - categorienaam in het Engels.
desc - categoriebeschrijving in het Engels.

Voorbeeldcategorie-array:

[
    {
        "id": 4,
        "idstr": "services",
        "name": "Services",
        "desc": "TLDs for representing the service industry."
    },
    {
        "id": 6,
        "idstr": "food",
        "name": "Food & Drink",
        "desc": "Domain extensions for dining, cooking, restaurants, and beverages."
    }
]
data[].dnssecSupported boolean Als de DNS-zone van het register DNS Security Extensions (DNSSEC) ondersteunt.
data[].hasPremiumDomains object Object van [pricetype] sleutels en booleaanse waarden, die aangeven of het register hogere prijzen aanrekent voor bepaalde "premium" domeinnamen. Voorbeeld:

{
    "hasPremiumDomains": {
        "register": false,
        "renewal": false
    }
}
data[].infoUpdated string ISO 8601 datetime (UTC timezone) van wanneer de TLD's basisinformatie (beperkingen, beschikbaarheidsdata, enz.) het laatst gecontroleerd en bijgewerkt werd. Opmerking: een nieuwe updated.info datum geeft niet noodzakelijkerwijs aan dat er een wijziging in de gegevens heeft plaatsgevonden. Het geeft alleen aan wanneer de gegevens voor het laatst gecontroleerd en ingesteld zijn.
data[].intendedUsage string Algemene informatie over hoe de extensie naar verwachting door de registranten zal worden gebruikt.
data[].language string De ISO 639-1 taalcode van 2 tekens. Als de taal gebaseerd is op het Engels of onbekend is, zal dit veld niet aanwezig zijn.
data[].level integer Integer die het domeinniveau van de extensie weergeeft. 1 = topleveldomein, 2 = domein op het tweede niveau, 3 = domein op het derde niveau, enz.
data[].localPresenceRequired boolean Als het register vereist dat de inschrijver een fysiek adres in de regio heeft.
data[].median object Object met de mediane prijs van de extensie, per prijstype, voor de opgenomen registratiehouders. Voorbeeld:

{
    "median": {
        "register": "3.17",
        "renewal": "20.17",
        "transfer": "8.17"
    }
}
data[].median[pricetype] string De mediane prijs van de extensie als een numerieke tekenreeks voor [pricetype], waarbij de [pricetype] sleutel register, renewal, transfer, restore, whoisprivacy is.
data[].name string Unicode naam van de domeinextensie.
data[].nameservers array De root nameservers van het register die de gezaghebbende nameservers van geregistreerde domeinen opslaan. Voorbeeldreeks van naamservers:

{
    "nameservers": [
        {
            "host": "a.gtld-servers.net",
            "ipv4": "192.5.6.30",
            "ipv6": "2001:503:a83e:0:0:0:2:30"
        },
        {
            "host": "b.gtld-servers.net",
            "ipv4": "192.33.14.30",
            "ipv6": "2001:503:231d:0:0:0:2:30"
        }
    ]
}
data[].parentTld string Het bovenliggende topleveldomein van de extensie. Als dit een TLD is, zal dit veld niet aanwezig zijn.
data[].pricingUpdated string ISO 8601 datetime (UTC timezone) van wanneer de prijzen van TLD's registrar voor het laatst gecontroleerd en bijgewerkt zijn. Opmerking: een nieuwe bijgewerkte.prijsstellingsdatum geeft niet noodzakelijkerwijs aan dat er een gegevenswijziging heeft plaatsgevonden. Het geeft alleen aan wanneer de gegevens voor het laatst gecontroleerd en ingesteld zijn.
data[].punycode string Punycodenaam van de domeinextensie. Alleen aanwezig voor IDN-extensies.
data[].registerMaxYears integer Maximum aantal jaren dat een domein geregistreerd kan worden op het moment van aankoop.
data[].registerMinYears integer Minimum aantal jaren dat een domein geregistreerd kan worden op het moment van aankoop.
data[].registrarsIncluded integer Aantal inschrijvers in de geretourneerde reeks inschrijvers.
data[].registrarsTotal integer Totaal aantal actieve registratiehouders die de extensie verkopen.
data[].registrars array of objects Array van object(en) RegistrarPricing met gegevens over registrarprijzen en -kenmerken.
data[].registryUrl string De officiële website van de registry voor informatie over TLD-registratie.
data[].renewalMinYears integer Minimaal aantal jaren dat een domein kan worden verlengd.
data[].restrictions string Een korte beschrijving van de TLD's registratiebeperkingen en -vereisten. Als er geen beperkingen zijn, zal dit veld niet aanwezig zijn
data[].sponsor object Object met gegevens over de sponsororganisatie of beheerorganisatie van de extensie.
data[].sponsor.name string De naam van de door ICANN goedgekeurde sponsororganisatie van de extensie of ccTLD beheerorganisatie.
data[].sponsor.address string Fysieke locatie van de sponsororganisatie of ccTLD beheerorganisatie. Voorbeeld adressenreeks:

{
    "sponsor": {
        "address": [
            "Minerva House",
            "Edmund Halley Road",
            "Oxford Science Park",
            "Oxford OX4 4DQ",
            "United Kingdom"
        ]
    }
}
data[].sponsorParentCompany string Naam van de entiteit die een meerderheidsbelang heeft in de sponsororganisatie.
data[].romanized string De TLD getranscribeerd in Latijnse karakters. Als de taal gebaseerd is op het Engels, of onbekend is, zal dit veld niet aanwezig zijn.
data[].rtl string Als de extensie van "rechts naar links" wordt gelezen (d.w.z. Arabric TLDs), dan is deze waarde __true__. Als het van "links naar rechts" wordt gelezen, is deze waarde __false__. Indien onbekend, zal deze waarde niet aanwezig zijn.
data[].syntax object Object met details over de toegestane domeinnaamregels en beperkingen van de extensie.
data[].syntax.minChars integer Minimumaantal tekens in label dat geregistreerd mag worden.
data[].syntax.maxChars integer Maximum aantal tekens in het label dat geregistreerd mag worden.
data[].targetMarket string De mensen of entiteiten waar het TLD voor bedoeld is.
data[].translation string De Engelse vertaling van de TLD. Als de TLD al op het Engels gebaseerd is, of als de vertaling onbekend is, zal deze waarde niet aanwezig zijn.
data[].type string Het type TLD dat wordt geïdentificeerd door een van de volgende strings:

gTLD: generiek topleveldomein.
ccTLD : landcode topleveldomein.
grTLD: generiek-beperkt topleveldomein.
sTLD: gesponsord topleveldomein.
data[].wholesale object Object met de groothandelsprijzen van de extensie per prijstype. Groothandelsprijzen zijn de prijzen die door het register aan een registrar in rekening worden gebracht voor domeinnaamaankopen. Voorbeeld:

{
    "wholesale": {
        "register": "8.97",
        "renewal": "8.97",
        "transfer": "8.97"
    }
}
data[].whoisPrivacySupported boolean Als de extensie WHOIS-privacydiensten toestaat om de namen en contactgegevens van domeinnaamhouders te maskeren. Indien onbekend, is dit veld niet aanwezig.
data[].whoisServer boolean Hostnaam van de server van het register waarop de contactgegevens van de domeinregistrant worden opgeslagen.

Voorbeeld verzoek/antwoord

curl -X POST https://api.tld-list.com/v1/extension/get -H 'Content-Type: application/json' -d '{"extensions": ["com"], "includeRegistrars": ["porkbun","godaddy","epik"], "apiKeyPublic":"MY_PUBLIC_KEY","apiKeyPrivate":"MY_PRIVATE_KEY"}'

{
   "data" : [
      {
         "average" : {
            "register" : "7.63",
            "renewal" : "13.63",
            "transfer" : "9.63"
         },
         "clicks" : 226,
         "dnssecSupported" : true,
         "hasPremiumDomains" : {
            "register" : false,
            "renewal" : false
         },
         "infoUpdated" : "2023-02-04T11:05:09",
         "level" : 1,
         "localPresenceRequired" : false,
         "median" : {
            "register" : "3.17",
            "renewal" : "20.17",
            "transfer" : "8.17"
         },
         "name" : "com",
         "nameservers" : [
            {
               "host" : "a.gtld-servers.net",
               "ipv4" : "192.5.6.30",
               "ipv6" : "2001:503:a83e:0:0:0:2:30"
            },
            {
               "host" : "b.gtld-servers.net",
               "ipv4" : "192.33.14.30",
               "ipv6" : "2001:503:231d:0:0:0:2:30"
            },
            {
               "host" : "c.gtld-servers.net",
               "ipv4" : "192.26.92.30",
               "ipv6" : "2001:503:83eb:0:0:0:0:30"
            },
            {
               "host" : "d.gtld-servers.net",
               "ipv4" : "192.31.80.30",
               "ipv6" : "2001:500:856e:0:0:0:0:30"
            },
            {
               "host" : "e.gtld-servers.net",
               "ipv4" : "192.12.94.30",
               "ipv6" : "2001:502:1ca1:0:0:0:0:30"
            },
            {
               "host" : "f.gtld-servers.net",
               "ipv4" : "192.35.51.30",
               "ipv6" : "2001:503:d414:0:0:0:0:30"
            },
            {
               "host" : "g.gtld-servers.net",
               "ipv4" : "192.42.93.30",
               "ipv6" : "2001:503:eea3:0:0:0:0:30"
            },
            {
               "host" : "h.gtld-servers.net",
               "ipv4" : "192.54.112.30",
               "ipv6" : "2001:502:8cc:0:0:0:0:30"
            },
            {
               "host" : "i.gtld-servers.net",
               "ipv4" : "192.43.172.30",
               "ipv6" : "2001:503:39c1:0:0:0:0:30"
            },
            {
               "host" : "j.gtld-servers.net",
               "ipv4" : "192.48.79.30",
               "ipv6" : "2001:502:7094:0:0:0:0:30"
            },
            {
               "host" : "k.gtld-servers.net",
               "ipv4" : "192.52.178.30",
               "ipv6" : "2001:503:d2d:0:0:0:0:30"
            },
            {
               "host" : "l.gtld-servers.net",
               "ipv4" : "192.41.162.30",
               "ipv6" : "2001:500:d937:0:0:0:0:30"
            },
            {
               "host" : "m.gtld-servers.net",
               "ipv4" : "192.55.83.30",
               "ipv6" : "2001:501:b1f9:0:0:0:0:30"
            }
         ],
         "pricingUpdated" : "2023-02-04T11:04:33",
         "registerMaxYears" : 10,
         "registerMinYears" : 1,
         "registrars" : [
            {
               "currency" : "USD",
               "freeFeatures" : [
                  {
                     "name" : "dns"
                  },
                  {
                     "name" : "whois-privacy"
                  }
               ],
               "id" : "godaddy",
               "name" : "GoDaddy",
               "notes" : {
                  "feeIcann" : {
                     "addedToListPrice" : true,
                     "amount" : "0.18",
                     "pricetype" : [
                        "register",
                        "renewal",
                        "transfer"
                     ]
                  },
                  "feeTax" : [
                     {
                        "addedToListPrice" : false,
                        "amountRate" : "~",
                        "amountRateType" : "percent-varies-by-location",
                        "appliesToCustomers" : [
                           "eu"
                        ],
                        "type" : "vat"
                     },
                     {
                        "addedToListPrice" : false,
                        "amountRate" : "15",
                        "amountRateType" : "percent",
                        "appliesToCustomers" : [
                           "in"
                        ],
                        "type" : "gst"
                     },
                     {
                        "addedToListPrice" : false,
                        "amountRate" : "10",
                        "amountRateType" : "percent",
                        "appliesToCustomers" : [
                           "au"
                        ],
                        "type" : "gst"
                     }
                  ]
               },
               "prices" : {
                  "register" : "3.17",
                  "renewal" : "20.17",
                  "transfer" : "8.17",
                  "whoisPrivacy" : "0.00"
               },
               "pricesOriginal" : {
                  "register" : "10.18"
               },
               "promos" : [
                  {
                     "amount" : "2.99",
                     "code" : "GDD2dom",
                     "pricetype" : [
                        "register"
                     ],
                     "start" : "2023-01-01T00:00:00",
                     "type" : "price"
                  }
               ],
               "terms" : {
                  "limitPerCustomer" : {
                     "count" : 1,
                     "pricetype" : [
                        "register"
                     ]
                  }
               },
               "threeYearValueScore" : "5.76"
            },
            {
               "currency" : "USD",
               "freeFeatures" : [
                  {
                     "name" : "whois-privacy"
                  },
                  {
                     "name" : "dns"
                  }
               ],
               "id" : "epik",
               "name" : "Epik",
               "prices" : {
                  "register" : "9.99",
                  "renewal" : "10.99",
                  "restore" : "90.00",
                  "transfer" : "9.99",
                  "whoisPrivacy" : "0.00"
               },
               "threeYearValueScore" : "8.29"
            },
            {
               "currency" : "USD",
               "freeFeatures" : [
                  {
                     "name" : "whois-privacy"
                  },
                  {
                     "name" : "dns"
                  },
                  {
                     "name" : "email-forward"
                  },
                  {
                     "name" : "ssl-cert"
                  }
               ],
               "id" : "porkbun",
               "name" : "Porkbun",
               "prices" : {
                  "register" : "8.73",
                  "renewal" : "9.73",
                  "transfer" : "9.73",
                  "whoisPrivacy" : "0.00"
               },
               "pricesOriginal" : {
                  "register" : "9.73"
               },
               "promos" : [
                  {
                     "amount" : "1.00",
                     "code" : "AWESOMENESS",
                     "pricetype" : [
                        "register"
                     ],
                     "type" : "discount"
                  }
               ],
               "terms" : {
                  "limitPerCustomer" : {
                     "count" : 1,
                     "pricetype" : [
                        "register"
                     ]
                  }
               },
               "threeYearValueScore" : "16.03"
            }
         ],
         "registryUrl" : "http://www.verisigninc.com",
         "renewalMinYears" : 1,
         "rtl" : false,
         "sponsor" : {
            "address" : [
               "12061 Bluemont Way",
               "Reston Virginia 20190",
               "United States"
            ],
            "name" : "VeriSign Global Registry Services"
         },
         "syntax" : {
            "maxChars" : 63,
            "minChars" : 2
         },
         "type" : "gTLD",
         "whoisPrivacySupported" : true,
         "whoisServer" : "whois.verisign-grs.com",
         "wholesale" : {
            "register" : "8.97",
            "renewal" : "8.97",
            "transfer" : "8.97"
         }
      }
   ],
   "errors" : [],
   "seconds" : 0.068,
   "status" : "SUCCESS"
}

getNames

Geeft als resultaat alle uitbreidingsnamen.

API eindpunt:https://api.tld-list.com/v1/extension/getNames

Reactietijd:~1 second

Aanvraagparameters

Sleutel Type Vereist Beschrijving
omitExtensionsWithoutRegistrars boolean Als dit waar is, worden extensies die geen prijsgegevens van een registrar in de resultaten hebben, weggelaten. De standaardwaarde is onwaar.
wantPunycode boolean Codeer alle geretourneerde IDN-extensies als punycode in plaats van unicode. Standaard is false.

Antwoordobject

Pad Type Beschrijving
data array of strings Array van uitbreidingsnamen.

Voorbeeld verzoek/antwoord

curl -X POST https://api.tld-list.com/v1/extension/getNames -H 'Content-Type: application/json' -d '{"apiKeyPublic":"MY_PUBLIC_KEY","apiKeyPrivate":"MY_PRIVATE_KEY", "wantPunycode": true, "omitExtensionsWithoutRegistrars": true}'

{
   "data" : [
      "2000.hu",
      "5g.in",
      "6g.in",
      "aaa.pro",
      "abc.br",
      "abkhazia.su",
      "abo.pa",
      "abogado",
      "abr.it",
      "abruzzo.it",
      "abudhabi",
      ...
      "xn--3bst00m",
      "xn--jvr189m",
      "xn--imr513n",
      "xn--j6w193g",
      "xn--t60b56a",
      "xn--mk1bu44c",
      "xn--3e0b707e"
   ],
   "errors" : [],
   "seconds" : 0.697,
   "status" : "SUCCESS"
}

getCheapestRegistrar

Retourneert de goedkoopste registrars/providers, hun prijzen, mediaanprijs en gemiddelde prijs per domeinextensie. Extensies die door geen enkele registrar worden verkocht, worden niet geretourneerd.

API eindpunt:https://api.tld-list.com/v1/extension/getCheapestRegistrar

Reactietijd:~8 seconds for all extensions, ~4 seconds < 2000 extensions, ~1 second < 100 extensions

Aanvraagparameters

Sleutel Type Vereist Beschrijving
pricetypes array of strings

Specificeert de prijstypes om op te halen. Als dit wordt weggelaten, worden er 3 prijstypes (register, renewal, transfer) geretourneerd.

Voorbeeld: "pricetypes": ["register", "transfer"]

extensions array of strings

Specificeert welke extensies moeten worden opgehaald. Voeg geen punt toe. Extensienamen kunnen unicode of hun punycode-equivalent zijn. Als dit wordt weggelaten, worden alle extensies op TLD-List geretourneerd.

Voorbeeld: "extensions": ["com", "io", "co.uk", "移动", "xn--p1ai"]

includeRegistrars array of strings

De string-ID's van actieve registratiehouders om mee te nemen bij het bepalen van de goedkoopste prijzen en aggregaatberekeningen. Registrars die niet in deze parameter worden gespecificeerd, worden genegeerd. Gebruik de methode getIds om een lijst met ID's van alle actieve registratiehouders op TLD-List te verkrijgen.

Als deze parameter wordt weggelaten, worden alle registratiehouders die actief worden vermeld op TLD-List in aanmerking genomen.

Voorbeeld: "includeRegistrars": ["godaddy", "porkbun", "namecheap"]

excludeRegistrars array of strings

De string ID's van actieve registratiehouders die moeten worden uitgesloten bij het bepalen van de goedkoopste prijzen en samengevoegde berekeningen. Gebruik de methode getIds om een lijst met ID's van alle actieve registratiehouders op TLD-List te verkrijgen.

Als deze parameter wordt weggelaten, worden er geen registratiehouders genegeerd.

Voorbeeld: "excludeRegistrars": ["godaddy", "porkbun", "namecheap"]

omitExtensionsWithoutRegistrars boolean

Als dit waar is, worden extensies die geen registrarprijsgegevens in de resultaten hebben, weggelaten. Deze situatie doet zich voor wanneer de parameters excludeRegistrars en/of includeRegistrars ervoor hebben gezorgd dat een extensie die normaal gesproken prijsgegevens van een registrar heeft, geen bijbehorende prijsgegevens van een registrar heeft. Deze extensies zijn standaard inbegrepen, maar met lege matrices voor hun prijsgegevens. Stel in op true om deze extensies uit de resultaten weg te laten.

Voorbeeld: "omitExtensionsWithoutRegistrars": true

Antwoordobject

Pad Type Beschrijving
data array of objects Array van objecten, die elk een domeinextensie vertegenwoordigen.
data[].name string Unicode naam van de domeinextensie.
data[].punycode string Punycodenaam van de domeinextensie. Alleen aanwezig voor IDN-extensies.
data[].currency string De ISO 4217 valutacode van drie letters van de prijsgegevens. Deze waarde is momenteel alleen USD.
data[].registrarsIncluded number Aantal registratiehouders in de geretourneerde prijsgegevens.
data[].average object Object met de gemiddelde prijs van de extensie, per prijstype, voor de opgenomen registratiehouders.
data[].average[pricetype] string De gemiddelde prijs van de extensie als een numerieke tekenreeks voor [pricetype], waarbij de [pricetype] sleutel register, renewal, transfer is.
data[].median object Object met de mediane prijs van de extensie, per prijstype, voor de opgenomen registratiehouders.
data[].median[pricetype] string De mediane prijs van de extensie als een numerieke tekenreeks voor [pricetype], waarbij de [pricetype] sleutel register, renewal, transfer is.
data[].cheapest object Object met de goedkoopste registrars voor de extensie volgens prijstype.
data[].cheapest[pricetype] array of objects

Matrix van RegistrarPricing-object (en) met de goedkoopste registrar(s) volgens [prijstype], waarbij de sleutel [prijstype] register, renewal, transfer is.

Deze gegevens zijn een matrix omdat de goedkoopste prijs voor de extensie hetzelfde kan zijn voor meerdere registratiehouders.

Voorbeeld verzoek/antwoord

curl -X POST https://api.tld-list.com/v1/extension/getCheapestRegistrar -H 'Content-Type: application/json' -d '{"apiKeyPublic":"MY_PUBLIC_KEY","apiKeyPrivate":"MY_PRIVATE_KEY", "includeRegistrars": ["godaddy", "namecheap", "porkbun", "namesilo", "netim"], "extensions": ["com", "co.uk"]}'

{
   "data" : [
      {
         "average" : {
            "register" : "7.85",
            "renewal" : "10.25",
            "transfer" : "11.99"
         },
         "cheapest" : {
            "register" : [
               {
                  "currency" : "USD",
                  "freeFeatures" : [
                     {
                        "name" : "dns"
                     },
                     {
                        "name" : "email-forward"
                     },
                     {
                        "name" : "ssl-cert"
                     }
                  ],
                  "id" : "porkbun",
                  "name" : "Porkbun",
                  "price" : "4.96",
                  "priceOriginal" : "5.96",
                  "prices" : {
                     "register" : "4.96",
                     "renewal" : "5.96"
                  },
                  "pricesOriginal" : {
                     "register" : "5.96"
                  },
                  "pricetype" : "register",
                  "promo" : {
                     "amount" : "1.00",
                     "code" : "AWESOMENESS",
                     "type" : "discount"
                  },
                  "promos" : [
                     {
                        "amount" : "1.00",
                        "code" : "AWESOMENESS",
                        "type" : "discount"
                     }
                  ],
                  "terms" : {
                     "limitPerCustomer" : {
                        "count" : 1
                     }
                  },
                  "threeYearValueScore" : "18.36"
               }
            ],
            "renewal" : [
               {
                  "currency" : "USD",
                  "freeFeatures" : [
                     {
                        "name" : "dns"
                     },
                     {
                        "name" : "email-forward"
                     },
                     {
                        "name" : "ssl-cert"
                     }
                  ],
                  "id" : "porkbun",
                  "name" : "Porkbun",
                  "price" : "5.96",
                  "prices" : {
                     "register" : "4.96",
                     "renewal" : "5.96"
                  },
                  "pricetype" : "renewal",
                  "threeYearValueScore" : "18.36"
               }
            ],
            "transfer" : [
               {
                  "currency" : "USD",
                  "freeFeatures" : [
                     {
                        "name" : "dns"
                     }
                  ],
                  "id" : "godaddy",
                  "name" : "GoDaddy",
                  "notes" : {
                     "feeTax" : [
                        {
                           "addedToListPrice" : false,
                           "amountRate" : "~",
                           "amountRateType" : "percent-varies-by-location",
                           "appliesToCustomers" : [
                              "eu"
                           ],
                           "type" : "vat"
                        },
                        {
                           "addedToListPrice" : false,
                           "amountRate" : "15",
                           "amountRateType" : "percent",
                           "appliesToCustomers" : [
                              "in"
                           ],
                           "type" : "gst"
                        },
                        {
                           "addedToListPrice" : false,
                           "amountRate" : "10",
                           "amountRateType" : "percent",
                           "appliesToCustomers" : [
                              "au"
                           ],
                           "type" : "gst"
                        }
                     ]
                  },
                  "price" : "11.99",
                  "prices" : {
                     "register" : "6.49",
                     "renewal" : "11.99",
                     "transfer" : "11.99"
                  },
                  "pricetype" : "transfer",
                  "threeYearValueScore" : "3.46"
               }
            ]
         },
         "currency" : "USD",
         "median" : {
            "register" : "6.48",
            "renewal" : "10.78",
            "transfer" : "11.99"
         },
         "name" : "co.uk",
         "registrarsIncluded" : 4,
         "registrarsTotal" : 47
      },
      {
         "average" : {
            "register" : "8.90",
            "renewal" : "14.10",
            "transfer" : "9.30"
         },
         "cheapest" : {
            "register" : [
               {
                  "currency" : "USD",
                  "freeFeatures" : [
                     {
                        "name" : "dns"
                     },
                     {
                        "name" : "whois-privacy"
                     }
                  ],
                  "id" : "godaddy",
                  "name" : "GoDaddy",
                  "notes" : {
                     "feeIcann" : {
                        "addedToListPrice" : true,
                        "amount" : "0.18"
                     },
                     "feeTax" : [
                        {
                           "addedToListPrice" : false,
                           "amountRate" : "~",
                           "amountRateType" : "percent-varies-by-location",
                           "appliesToCustomers" : [
                              "eu"
                           ],
                           "type" : "vat"
                        },
                        {
                           "addedToListPrice" : false,
                           "amountRate" : "15",
                           "amountRateType" : "percent",
                           "appliesToCustomers" : [
                              "in"
                           ],
                           "type" : "gst"
                        },
                        {
                           "addedToListPrice" : false,
                           "amountRate" : "10",
                           "amountRateType" : "percent",
                           "appliesToCustomers" : [
                              "au"
                           ],
                           "type" : "gst"
                        }
                     ]
                  },
                  "price" : "3.17",
                  "priceOriginal" : "10.18",
                  "prices" : {
                     "register" : "3.17",
                     "renewal" : "20.17",
                     "transfer" : "8.17",
                     "whoisPrivacy" : "0.00"
                  },
                  "pricesOriginal" : {
                     "register" : "10.18"
                  },
                  "pricetype" : "register",
                  "promo" : {
                     "amount" : "2.99",
                     "code" : "GDD2dom",
                     "start" : "2023-01-01T00:00:00",
                     "type" : "price"
                  },
                  "promos" : [
                     {
                        "amount" : "2.99",
                        "code" : "GDD2dom",
                        "start" : "2023-01-01T00:00:00",
                        "type" : "price"
                     }
                  ],
                  "terms" : {
                     "limitPerCustomer" : {
                        "count" : 1
                     }
                  },
                  "threeYearValueScore" : "5.76"
               }
            ],
            "renewal" : [
               {
                  "currency" : "USD",
                  "freeFeatures" : [
                     {
                        "name" : "whois-privacy"
                     },
                     {
                        "name" : "dns"
                     },
                     {
                        "name" : "email-forward"
                     },
                     {
                        "name" : "ssl-cert"
                     }
                  ],
                  "id" : "porkbun",
                  "name" : "Porkbun",
                  "price" : "9.73",
                  "prices" : {
                     "register" : "8.73",
                     "renewal" : "9.73",
                     "transfer" : "9.73",
                     "whoisPrivacy" : "0.00"
                  },
                  "pricetype" : "renewal",
                  "threeYearValueScore" : "16.03"
               }
            ],
            "transfer" : [
               {
                  "currency" : "USD",
                  "freeFeatures" : [
                     {
                        "name" : "dns"
                     },
                     {
                        "name" : "whois-privacy"
                     },
                     {
                        "name" : "email-forward"
                     }
                  ],
                  "id" : "namecheap",
                  "name" : "Namecheap",
                  "notes" : {
                     "feeIcann" : {
                        "addedToListPrice" : true,
                        "amount" : "0.18"
                     }
                  },
                  "price" : "7.16",
                  "prices" : {
                     "register" : "6.16",
                     "renewal" : "14.16",
                     "restore" : "13.98",
                     "transfer" : "7.16",
                     "whoisPrivacy" : "0.00"
                  },
                  "pricetype" : "transfer",
                  "terms" : {
                     "limitPerCustomer" : {
                        "count" : 1
                     }
                  },
                  "threeYearValueScore" : "10.15"
               }
            ]
         },
         "currency" : "USD",
         "median" : {
            "register" : "10.95",
            "renewal" : "10.95",
            "transfer" : "9.95"
         },
         "name" : "com",
         "registrarsIncluded" : 5,
         "registrarsTotal" : 59
      }
   ],
   "errors" : [],
   "seconds" : 0.126,
   "status" : "SUCCESS"
}

Registrar Methoden

getIds

Retourneert alle registratiehouder-ID's, die elk een unieke registratiehouder identificeren die actief is vermeld op TLD-List.

API eindpunt:https://api.tld-list.com/v1/registrar/getIds

Reactietijd:< 1 second

Aanvraagparameters

Geen

Antwoordobject

Pad Type Beschrijving
data array of strings Array van string registrar-ID's.

Voorbeeld verzoek/antwoord

curl -X POST https://api.tld-list.com/v1/registrar/getIds -H 'Content-Type: application/json' -d '{"apiKeyPublic":"MY_PUBLIC_KEY","apiKeyPrivate":"MY_PRIVATE_KEY"}'

{
   "data" : [
      "101domain",
      "123reg",
      "above.com",
      ...
      "upflare",
      "webnames.ca"
   ],
   "errors" : [],
   "seconds" : 0.001,
   "status" : "SUCCESS"
}