Primeiros passos: primeira requisição à API Ghosting

A API pública do Ghosting é aberta e não exige cadastro. Este guia mostra como consultar um perfil e interpretar a resposta em três passos.

Escolha um username

Use qualquer nome de usuário cadastrado no Ghosting, sem o @. Por exemplo: ghosting.

Faça a requisição

Envie um GET para a rota de perfil:

curl -X GET "https://ghosting.fun/api/v1/users/ghosting" \
  -H "Accept: application/json"

const res = await fetch("https://ghosting.fun/api/v1/users/ghosting");
const { data } = await res.json();
console.log(data.displayName, data.views);

import requests
r = requests.get("https://ghosting.fun/api/v1/users/ghosting")
user = r.json()["data"]
print(user["displayName"], user["views"])

Leia a resposta

A API retorna um objeto JSON com success, data (o perfil) e meta (timestamp, versão, tempo de execução).

{
  "success": true,
  "data": {
    "username": "ghosting",
    "displayName": "Ghosting Oficial",
    "views": 32890,
    "status": "active",
    "badges": { "isVerified": true, "isOfficial": true }
  },
  "meta": { "version": "v1", "executionTimeMs": 6 }
}

Alternativa via query parameter

Se preferir passar o username como parâmetro de consulta:

GET https://ghosting.fun/api/v1/users?username=ghosting

A API responde com 200 OK mesmo para perfis suspensos. Verifique data.status e data.banInfo.isBanned antes de exibir o perfil. Veja mais em Arquitetura de moderação.

Próximos passos

Ver todos os endpoints

Referência completa das rotas REST v1.

Entender a resposta

Todos os campos do objeto User.

⌘I

Introdução

Conceitos

Referência de API

Schemas

Guias

Primeiros passos: primeira requisição à API Ghosting

Alternativa via query parameter

Próximos passos

Ver todos os endpoints

Entender a resposta

​Alternativa via query parameter

​Próximos passos

Ver todos os endpoints

Entender a resposta

Alternativa via query parameter

Próximos passos