API Documentation

API ini membaca status username collectible dari Fragment search (searchAuctions, type usernames). Tidak ada fallback ke halaman lain dan tidak ada cek Telegram.

Base URL: …

Overview

Kirim username (dengan atau tanpa @). Server menormalisasi menjadi huruf kecil alfanumerik + underscore, lalu mencari di Fragment. Response berisi status marketplace (Taken, Sold, Available, dll).

Ringkasan endpoint
MethodPathAuthKeterangan
GET/docsTidakDokumentasi ini
GET/api/v1/username/:namewajibCek 1 username

Content-Type response: application/json (kecuali halaman docs).

Authentication wajib untuk semua path di bawah /api/v1/. Server menolak start jika API_KEY kosong di .env.

Kirim API key dengan salah satu cara berikut (prioritas: header X-API-Key → Authorization → query token):

X-API-Key: YOUR_KEY

Authorization: Bearer YOUR_KEY

GET /api/v1/username/handokoxn?token=YOUR_KEY

Tanpa key yang valid → HTTP 401 {"ok":false,"error":"unauthorized"}

Status Fragment

Nilai result.status diambil dari badge Fragment search.

status (contoh)Arti singkat
TakenUsername sudah dipakai / tidak dijual di listing search
UnavailableTidak tersedia untuk dibeli (sering mirip taken/held)
SoldSudah terjual sebagai collectible
AvailableBisa di-auction / listing available di Fragment
On auctionSedang dilelang
For saleDijual dengan harga tetap

Label persis mengikuti HTML Fragment; bisa berubah jika UI Fragment berubah.

GET

Lookup satu username

/api/v1/username/:name

Mencari :name di Fragment search. Jika username tidak muncul di hasil search → 404.

Parameters
NameInRequiredDescription
namepathrequired Username. Boleh handokoxn, @handokoxn, atau URL yang berakhiran username.
X-API-Key / Authorization / token header / queryrequired API key (lihat Authentication)
Example request


          
Example response — 200 OK

          
{
  "ok": true,
  "result": {
    "username": "handokoxn",
    "status": "Taken",
    "value": "Unknown",
    "url": "https://fragment.com/username/handokoxn"
  }
}


          
Example response — 404 Not Found

          
{
  "ok": false,
  "error": "fragment: username \"xyznotexist\" not found in search"
}


          
Example response — 401 Unauthorized

          
{
  "ok": false,
  "error": "unauthorized"
}

        

      


      

        
HTTP status codes

        

          

            
CodeKapan

            
200Sukses (GET username)

            
401API key hilang / salah

            
404Username tidak ketemu di Fragment search

            
502Gagal menghubungi / parse Fragment

            
503API_KEY belum dikonfigurasi di server

          

        

      


      

        
Field result

        

          

            
FieldTypeDescription

            
usernamestringUsername ternormalisasi (lowercase, tanpa @)

            
statusstringTeks status dari Fragment (Taken, Sold, …)

            
valuestringNilai/harga dari kolom Value bila ada (mis. Unknown, nominal TON)

            
urlstringLink halaman Fragment https://fragment.com/username/{name}