API Reference

How to work around with WebX's API, hosted at https://api.buss.lol.

This is the URI of the WebX API, which holds all the DNS of the network. You got different endpoints to do your stuff. https://api.buss.lol/.

APIs have rate limits. They are provided in the headers.

GET /

Provides a basic message explaining the API.

YOU SEND

REQUEST METHOD	TARGET URL
GET	https://api.buss.lol/

RETURNS

Hello, world! The available endpoints are:
GET /domains,
GET /domain/:name/:tld,
POST /domain,
PUT /domain/:key,
DELETE /domain/:key,
GET /tlds.
Ratelimits provided in headers.

GET /domains?amount={x}&page={y}

Being amount and page optional. amount for the amount of domains you want the response to have per page (defaults to 15), and page what page you want to view. Allows you to get the list of all working domains from the network.

YOU SEND

REQUEST METHOD	TARGET URL
GET	https://api.buss.lol/domains

RETURNS

response.json

{
    "domains": [
        {
            "tld": "it",
            "name": "register",
            "ip": "https://github.com/face-hh/webx-registrar"
        },
        {
            "tld": "it",
            "name": "dingle",
            "ip": "https://github.com/face-hh/dingle-frontend"
        }
    ],
    ...
    "page": 1,
    "limit": 15
}

GET /tlds

Allows you to get the list of all valid TLDS.

YOU SEND

REQUEST METHOD	TARGET URL
GET	https://api.buss.lol/tlds

RETURNS

200 OK

["mf", "btw", "fr", "yap", "dev", "scam", "zip", "root", "web", "rizz", "habibi", "sigma", "now", "it", "soy", "lol", "uwu"]

GET /domain/name/tld

Allows you to get the data from a specific domain. Being name the domain name (e.g. "register") and tld it's TLD (e.g. "it").

YOU SEND

REQUEST METHOD	TARGET URL
GET	https://api.buss.lol/domain/name/tld

RETURNS

IF DOMAIN DOES EXIST

{
    "tld":"it",
    "name":"register",
    "ip":"https://github.com/face-hh/webx-registrar"
}

IF DOMAIN DOES NOT EXIST

Does not return anything.

POST /domain

Allows you to register a domain from the API

YOU SEND

REQUEST METHOD	TARGET URL	HEADERS
POST	https://api.buss.lol/domain	Content-Type: application/json

AND BODY:

{
    "tld": "{tld}",
    "name": "{name}",
    "ip": "{ip}"
}

Being {name} the name you want to use as the domain, {tld} the TLD you want to use, and {ip} the IP / GitHub URL you want to serve from.

RETURNS

IF THE DOMAIN IS CREATED

200 OK

{
    "tld": "example_tld",
    "ip": "example_ip",
    "name": "example_name",
    "secret_key": "generated_secret_key"
}

IF THE BODY OF YOUR POST REQUEST IS NOT VALID

400 Bad Request

IF {name} (domain name) IS ALREADY REGISTERED WITH THAT TLD

409 Bad Request

IF RATE LIMIT HAS BEEN EXCEEDED

429 Too Many Requests

POST /domain/check

Allows you to "search" for domains using domain names and TLDs

YOU SEND

REQUEST METHOD	TARGET URL	HEADERS
POST	https://api.buss.lol/domain/check	None

AND BODY:

{
    "tld": "{tld}",
    "name": "{name}"
}

Being {name} the name you want to search for, and {tld} an optional parameter to also search for a specific TLD.

Quick reminder: unless specified, all parameters are required.

RETURNS

IF THE DOMAIN IS CREATED

200 OK

{
    "tld": "example_tld",
    "ip": "example_ip",
    "name": "example_name",
    "secret_key": "generated_secret_key"
}

IF THE BODY OF YOUR POST REQUEST IS NOT VALID

400 Bad Request

IF {name} (domain name) IS ALREADY REGISTERED WITH THAT TLD

409 Bad Request

IF RATE LIMIT HAS BEEN EXCEEDED

429 Too Many Requests

PUT /domain/key

Allows you to update your domain's IP / GitHub URL. The code's source, basically.

YOU SEND

REQUEST METHOD	TARGET URL	HEADERS
PUT	https://api.buss.lol/domain/:key	Content-Type: application/json

Being :key your domain's secret key.

AND BODY:

{
    "ip": "{ip}"
}

Being {ip} the new IP you want to set for your domain.

RETURNS

IF THE IP IS CORRECTLY UPDATED

200 OK

response.json

{
    "ip": "new_ip"
}

IF THE BODY OF YOUR PUT REQUEST IS NOT VALID OR SPECIFIED KEY IS NOT VALID

400 Bad Request

IF THE DOMAIN IS NOT FOUND

404 Bad Request

DELETE /domain/key

Allows you to delete your domain from the network. You cannot undo that, so be careful.

YOU SEND

REQUEST METHOD	TARGET URL	HEADERS
DELETE	https://api.buss.lol/domain/:key	No headers required

Being :key your domain's secret key.

RETURNS

IF THE DOMAIN IS CORRECTLY REMOVED

200 OK

IF THE REQUEST HAS AN INVALID PARAMETER

400 Bad Request

IF THE DOMAIN IS NOT FOUND

404 Bad Request

POST /registry/domain

Allows to create your own domain using an API key.

This is disabled by default as you will need to come up with your own way of validating and distributing API Keys.

YOU SEND

REQUEST METHOD	TARGET URL	HEADERS
POST	https://api.buss.lol/registry/domain/	Content-Type: application/json; Authorization = name:token

Being :token your API key.

AND BODY:

{
    "tld": "{tld}",
    "name": "{name}",
    "ip": "{ip}"
}

Being {name} the name you want to use as the domain, {tld} the TLD you want to use, and {ip} the IP / GitHub URL you want to serve from.

RETURNS

IF THE DOMAIN IS SUCCESSFULLY CREATED

200 OK

{
    "tld": "example_tld",
    "ip": "example_ip",
    "name": "example_name",
    "secret_key": "generated_secret_key"
}

IF THE BODY OF YOUR POST REQUEST IS NOT VALID

400 Bad Request

IF THE API KEY SYSTEM IS DISABLED

(It can be.)

403 Not allowed

IF THE REQUEST DOMAIN IS ALREADY REGISTERED

409 Conflict

IF THE RATE LIMIT IS EXCEEDED

429 Too many requests