Visão geral da solicitação em lote
Processe até 100 nomes
Envie um array data e receba um resultado por registro. Adicione um id do seu sistema para relacionar cada estimativa ao registro de origem com segurança.
askToAI e forceToGenderize não estão disponíveis. Para nomes em sistemas de escrita não latinos ou entradas que precisam de suporte de IA, use o endpoint de nome individual.
Cabeçalhos HTTP obrigatórios
Autorize a solicitação em lote
Content-Typeapplication/jsonAuthorizationBearer YOUR_API_KEYCorpo JSON da solicitação
Parâmetros
| Campo | Tipo | Obrigatoriedade | Descrição |
|---|---|---|---|
data | object[] | Obrigatório | Array contendo entre 1 e 100 registros de nomes. |
data[].name | string | Obrigatório | Primeiro nome a analisar. |
data[].country | string | Opcional | Código de país ISO 3166-1 alfa-2. Usa o resultado global quando não existe resultado para o país. |
data[].id | string | integer | Opcional | Identificador do seu registro, devolvido sem alterações para associar os resultados às entradas. |
Se não houver correspondência para o país informado, a GenderAPI retorna o resultado global disponível para o nome. Use códigos ISO 3166-1 alfa-2, como DE, IT ou US.
Corpo da solicitação
Monte o array de dados
{
"data": [
{ "name": "Andrea", "country": "DE", "id": "123" },
{ "name": "andrea", "country": "IT", "id": "456" },
{ "name": "james", "country": "US", "id": "789" }
]
}Exemplos de código
Envie uma solicitação com vários nomes
curl -X POST "https://api.genderapi.io/api/name/multi/country" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY" \
-d '{"data":[{"name":"Andrea","country":"DE","id":"123"},{"name":"andrea","country":"IT","id":"456"}]}'const data = [
{ name: "Andrea", country: "DE", id: "123" },
{ name: "andrea", country: "IT", id: "456" }
];
const response = await fetch("https://api.genderapi.io/api/name/multi/country", {
method: "POST",
headers: { "Content-Type": "application/json", "Authorization": "Bearer YOUR_API_KEY" },
body: JSON.stringify({ data })
});Resposta 200
Associe os resultados aos seus registros
{
"status": true,
"used_credits": 3,
"remaining_credits": 7265,
"expires": 1717069765,
"names": [
{ "name": "andrea", "q": "Andrea", "gender": "female", "country": "DE", "total_names": 644, "probability": 88, "id": "123" },
{ "name": "andrea", "q": "andrea", "gender": "male", "country": "IT", "total_names": 13537, "probability": 98, "id": "456" }
],
"duration": "5ms"
}Campos da resposta
| Campo | Tipo | Descrição |
|---|---|---|
status | boolean | Indica se a solicitação em lote foi concluída com sucesso. |
used_credits | integer | Créditos consumidos por todos os nomes enviados. |
remaining_credits | integer | Créditos disponíveis após a solicitação. |
expires | integer | Data de expiração do pacote em formato de timestamp UNIX. |
names | object[] | Coleção ordenada dos resultados de estimativa por nome. |
names[].name | string | Nome normalizado usado na estimativa. |
names[].q | string | Nome original enviado na solicitação. |
names[].gender | string | null | Valor estimado: male, female ou null. |
names[].country | string | Código de país considerado neste resultado. |
names[].total_names | integer | Quantidade de amostras que sustentam este resultado. |
names[].probability | integer | Probabilidade da estimativa em porcentagem. |
names[].id | string | integer | Identificador de entrada devolvido para relacionar o registro. |
duration | string | Tempo total de processamento no servidor. |
Mantenha cada solicitação em até 100 registros
Valide o array antes de enviá-lo e use um id único para relacionar os registros de forma determinística. Divida conjuntos de dados maiores em lotes de no máximo 100 nomes.
Próximo guia