Documentazione per sviluppatori

Documentazione Gender API

Determina il genere da nome proprio, nome completo, indirizzo email o username con semplici richieste REST e risposte JSON strutturate.

REST + JSONRichieste GETSingole e multipleContesto paese

Uso di base

Esegui la prima richiesta alla Gender API

Invia un valore e ricevi genere previsto, probabilità, paese e informazioni di utilizzo. Parti da un nome; usa invece l’endpoint dedicato quando disponi di un indirizzo email o di uno username.

Autenticazione

Aggiungi la chiave API tramite il parametro di query key. Conserva le chiavi di produzione sul server: non esporre mai una chiave privata nel codice del browser o in un repository pubblico.

Leggi la guida all’autenticazione →
Risorse API leggibili dalle macchine

Usa il contratto GenderAPI aggiornato in formato OpenAPI, Swagger o Postman.

GET

Genere dal nome

Nome proprio o nome completo

Usa l’endpoint principale quando l’input è un nome proprio o un nome completo.

https://api.genderapi.io/api
cURL
curl "https://api.genderapi.io/api?name=Alice&key=YOUR_API_KEY"

Parametri facoltativi

ParametroTipoDescrizione
countrystringCodice paese a due lettere, per esempio IT o US.
askToAIbooleanSe impostato su true, interroga il supporto AI quando il nome non è presente nel database.
forceToGenderizebooleanTenta una previsione per input insoliti che potrebbero non sembrare nomi di persona.
Usa questa opzione con cautela: le previsioni forzate per nomi di fantasia, nickname o input con pochi segnali possono essere meno accurate.
GET

Genere dall’email

Indirizzo email

L’endpoint email estrae un probabile nome dall’indirizzo prima di eseguire la previsione del genere.

https://api.genderapi.io/api/email
cURL
curl "https://api.genderapi.io/api/email?email=alice.rossi%40example.com&country=IT&askToAI=true&key=YOUR_API_KEY"
forceToGenderize non è disponibile per questo endpoint perché il nome viene estratto internamente.
GET

Genere dallo username

Username social

Usa questo endpoint per username, handle e nickname che possono contenere un nome riconoscibile.

https://api.genderapi.io/api/username
cURL
curl "https://api.genderapi.io/api/username?username=sparkling_unicorn&country=IT&askToAI=true&forceToGenderize=true&key=YOUR_API_KEY"

Risposta JSON

Comprendi la risposta di GenderAPI

I tre endpoint utilizzano la stessa struttura di risposta principale.

200 OK
{
  "status": true,
  "used_credits": 1,
  "remaining_credits": 4999,
  "expires": 1743659200,
  "q": "Alice",
  "name": "alice",
  "gender": "female",
  "country": "IT",
  "total_names": 325,
  "probability": 98,
  "duration": "4ms"
}

Campi della risposta

CampoTipoDescrizione
statusbooleanIndica se la richiesta è stata completata correttamente.
used_creditsintegerCrediti consumati dalla richiesta.
remaining_creditsintegerCrediti disponibili dopo la richiesta.
expiresintegerScadenza del pacchetto come timestamp UNIX.
qstringValore originale inviato: nome, email o username.
namestringNome proprio normalizzato o estratto.
genderstringGenere previsto: male, female oppure "null".
countrystringCodice paese ISO 3166-1 alpha-2 più probabile.
total_namesintegerNumero di record di nomi alla base della previsione.
probabilityintegerAttendibilità della previsione espressa in percentuale.
durationstringTempo di elaborazione della richiesta sul server.

Codifica sempre i valori nell’URL

Spazi e caratteri speciali devono essere codificati dal client HTTP. Per esempio, usa sparkling%20unicorn al posto di uno spazio non codificato.

Continua lo sviluppo

Scegli la guida adatta al tuo flusso di lavoro

Richieste per nomeEsempi singoli e multipli →Librerie clientUsa il linguaggio che preferisci →Gestione degli erroriRiferimento per stati ed errori →