Articles

GET /v1/articles

List articles

Returns all available articles in a list.

Example
$ curl --header "Authorization: Bearer {token}" \
       --header "Accept: application/json" \
       https://api.checkdomain.de/v1/articles
Response
HTTP/1.1 200 OK
{
    "page": 1,
    "limit": 10,
    "pages": 1,
    "total": 2,
    "_links": {
        "self": {
            "href": "/v1/articles?page=1&limit=10"
        },
        "first": {
            "href": "/v1/articles?page=1&limit=10"
        },
        "last": {
            "href": "/v1/articles?page=1&limit=10"
        }
    },
    "_embedded": {
        "articles": [
            {
                "id": 1,
                "tld": "de",
                "name": "*.de-Domain",
                "genre": "general",
                "period": "12",
                "prices": {
                    "create": {
                        "currency": "EUR",
                        "price": 20.99
                    },
                    "setup": {
                        "currency": "EUR",
                        "price": 4.90
                    }
                },
                "_links": {
                    "self": {
                        "href": "/v1/articles/1"
                    }
                }
            },
            {
                "id": 2,
                "tld": "com",
                "name": "*.com-Domain",
                "genre": "general",
                "period": "12",
                "prices": {
                    "create": {
                        "currency": "EUR",
                        "price": 19.99
                    },
                    "setup": {
                        "currency": "EUR",
                        "price": 9.90
                    }
                },
                "_links": {
                    "self": {
                        "href": "/v1/articles/2"
                    }
                }
            }
        ]
    }
}
Filters
Name Type Required Description
query string Article title
tld string Top-Level-Domain
page integer Page number
limit integer Items per page
Response
Name Type Required Description
root Show properties collection Yes array of objects (Article)
Properties of Article
Name Type Required Description
id integer Article identifier
tld string Top-Level-Domain
name string Article name
genre string Genre of Top-Level-Domain
prices Show properties model object (Prices)
Properties of Prices
Name Type Required Description
create Show properties model object (Price)
Properties of Price
Name Type Required Description
currency string
price float
setup object (Price) Setup fee
Status-Codes
Code Description
200 Ok

Get article

GET /v1/articles/{article}

Get article

Returns a single article by identifier

Example
$ curl --header "Authorization: Bearer {token}" \
       --header "Accept: application/json" \
       https://api.checkdomain.de/v1/articles/{article}
Response
HTTP/1.1 200 OK
{
    "id": 2,
    "tld": "com",
    "name": "*.com-Domain",
    "outdated": "false",
    "genre": "general",
    "period": "12",
    "prices": {
        "create": {
            "currency": "EUR",
            "price": 20.99
        },
        "setup": {
            "currency": "EUR",
            "price": 4.90
        },
        "transfer": {
            "currency": "EUR",
            "price": 1
        },
        "ownerchange": {
            "currency": "EUR",
            "price": 1
        },
        "update": {
            "currency": "EUR",
            "price": 1
        },
        "trustee": {
            "currency": "EUR",
            "price": 1
        },
        "delete": {
            "currency": "EUR",
            "price": 1
        },
        "restore": {
            "currency": "EUR",
            "price": 1
        }
    },
    "terms": {
        "idn": true,
        "numbered_names": true,
        "blocking_days": null,
        "length": {
            "min": 3,
            "max": 63
        },
        "required": {
            "authcode": false,
            "european_contact": true,
            "explicit_contact_from": "DE",
            "domain_like_company": true
        },
        "additionals": {
            "trustservice": true,
            "owner_change_new_period": true
        }
    },
    "_links": {
        "self": {
            "href": "/v1/articles/2"
        }
    }
}
Requirements
Name Type Required Description
article integer (\d+) Article identifier
Response
Name Type Required Description
id integer Article identifier
tld string Top-Level-Domain
name string Article name
genre string Genre of Top-Level-Domain
outdated boolean Article is outdated
prices Show properties model object (Prices)
Properties of Prices
Name Type Required Description
create Show properties model object (Price)
Properties of Price
Name Type Required Description
currency string
price float
setup object (Price) Setup fee
transfer object (Price) Transfer fee
ownerchange object (Price) Ownerchange fee
update object (Price) Update fee
trustee object (Price) Trustservice fee
delete object (Price) Cancellation fee
restore object (Price) Restore fee
terms Show properties model object (Terms)
Properties of Terms
Name Type Required Description
idn boolean Indicates whether special characters allowed
numbered_names boolean Indicates whether only numbers allowed
blocking_days integer Blocking days after domain transfer
length Show properties model object (Length)
Properties of Length
Name Type Required Description
min integer Minimum count of characters
max integer Maximum count of characters
required Show properties model object (Required)
Properties of Required
Name Type Required Description
authcode boolean Indicates whether authcode is required for domain transfer
european_contact boolean Indicates whether registration only possible from europe
explicit_contact_from string Indicates whether a registration needs a explicit contact from specific country
domain_like_company boolean Indicates whether domain name has to match company name
additionals Show properties model object (Additionals)
Properties of Additionals
Name Type Required Description
trustservice boolean Indicates whether trustservice is possible
new_period_after_change_owner boolean Indicates whether a new contract period starts after ownerchange
Status-Codes
Code Description
200 Ok