Check if a branded domain (e.g., go.mycompany.com) is available to be registered on Jmpy.me.
Path Parameters
The domain to check. Only alphanumeric characters, dashes, and dots are allowed.
Response
Whether the domain is available.
Request Examples
cURL
Node.js
TypeScript
Python
PHP
Go
Java
curl -X GET "https://jmpy.me/api/v1/domains/check-domain/go.acme.com" \
-H "Authorization: Bearer YOUR_API_KEY"
const fetch = require('node-fetch');
const response = await fetch('https://jmpy.me/api/v1/domains/check-domain/go.acme.com', {
headers: { 'Authorization': 'Bearer YOUR_API_KEY' }
});
const data = await response.json();
console.log(data);
import axios from 'axios';
const response = await axios.get(
'https://jmpy.me/api/v1/domains/check-domain/go.acme.com',
{ headers: { 'Authorization': 'Bearer YOUR_API_KEY' } }
);
console.log(response.data);
import requests
response = requests.get(
'https://jmpy.me/api/v1/domains/check-domain/go.acme.com',
headers={'Authorization': 'Bearer YOUR_API_KEY'}
)
print(response.json())
<?php
$client = new GuzzleHttp\Client();
$response = $client->request('GET', 'https://jmpy.me/api/v1/domains/check-domain/go.acme.com', [
'headers' => [
'Authorization' => 'Bearer YOUR_API_KEY'
]
]);
?>
package main
import (
"net/http"
)
func main() {
url := "https://jmpy.me/api/v1/domains/check-domain/go.acme.com"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer YOUR_API_KEY")
http.DefaultClient.Do(req)
}
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.URI;
import java.net.http.HttpResponse;
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://jmpy.me/api/v1/domains/check-domain/go.acme.com"))
.header("Authorization", "Bearer YOUR_API_KEY")
.GET()
.build();
client.send(request, HttpResponse.BodyHandlers.ofString());
Response Examples
{
"success": true,
"data": {
"domain": "go.acme.com",
"available": true,
"message": "Domain is available"
}
}
Use Cases
Check availability before attempting to register access to a domain.async function registerDomain(domain) {
// 1. Check availability first
const checkResponse = await fetch(
`https://jmpy.me/api/v1/domains/check-domain/${domain}`,
{ headers: { 'Authorization': 'Bearer YOUR_API_KEY' } }
);
const checkResult = await checkResponse.json();
if (!checkResult.data.available) {
throw new Error(`Domain ${domain} is not available`);
}
// 2. Register if available
const createResponse = await fetch(
'https://jmpy.me/api/v1/domains/branded',
{
method: 'POST',
headers: {
'Authorization': 'Bearer YOUR_API_KEY',
'Content-Type': 'application/json'
},
body: JSON.stringify({ domain })
}
);
return await createResponse.json();
}
Create Branded Domain
Register the domain if available
List Domains
View your currently registered domains
