기본 사용법
GenderAPI를 사용하면 다양한 유형의 입력 데이터를 통해 사람의 성별을 파악할 수 있습니다. 이름을 직접 분석하거나 이메일 주소 및 사용자 이름에서 이름을 추출할 수 있습니다. 시작하는 방법은 다음과 같습니다:
1. 이름으로 성별 판별
다음 엔드포인트로 이름을 전송합니다:
https://api.genderapi.io/api
예시:
curl "https://api.genderapi.io/api?name=Alice&key=YOUR_API_KEY"
선택적 매개변수도 추가할 수 있습니다:
-
country: 예측 정확도를 높이기 위해 두 글자의 국가 코드
(
ISO 3166-1 alpha-2
)
를 전달합니다. 예:
country=KR
(대한민국). -
askToAI:
true
로 설정하면, 이름이 데이터베이스에 없을 경우 AI 모델이 성별을 예측합니다. -
forceToGenderize:
true
로 설정하면, sparkling unicorn이나 mystic warrior와 같은 별명이나 판타지 이름처럼 실제 사람 이름처럼 보이지 않는 입력에 대해서도 성별을 추측하려 시도합니다. 사용자 이름 분석에 유용할 수 있으나 정확도는 낮아질 수 있습니다. 참고: 이 매개변수는 이메일 엔드포인트에서는 사용할 수 없습니다.
매개변수를 포함한 예시:
curl "https://api.genderapi.io/api?name=sparkling%20unicorn&country=US&askToAI=true&forceToGenderize=true&key=YOUR_API_KEY"
2. 이메일 주소로 성별 판별
이메일 주소만 있는 경우 다음 엔드포인트를 사용하세요:
https://api.genderapi.io/api/email
예시:
curl "https://api.genderapi.io/api/email?email=alice.smith@example.com&country=KR&askToAI=true&key=YOUR_API_KEY"
참고: 이 엔드포인트는 내부적으로 먼저 이름을 추출하므로 forceToGenderize
매개변수는 사용할 수 없습니다.
3. 사용자 이름으로 성별 판별
사용자 이름이나 별명의 경우 다음 엔드포인트를 사용하세요:
https://api.genderapi.io/api/username
예시:
curl "https://api.genderapi.io/api/username?username=sparkling_unicorn&country=US&askToAI=true&forceToGenderize=true&key=YOUR_API_KEY"
forceToGenderize
매개변수는 이 경우에 특히 유용합니다. 사용자 이름은 일반적으로 이름이 아닌 단어 또는 판타지 용어를 포함하고 있으므로, 입력이 일반적인 이름이 아니더라도 API가 성별 예측을 시도하도록 합니다.
모든 방법은 단일 요청과 일괄 요청을 지원합니다. 자세한 내용은 왼쪽 내비게이션 메뉴에서 해당 섹션을 확인하세요.
✅ API 응답
모든 엔드포인트에 대한 JSON 응답 예시:
{
"status": true,
"used_credits": 1,
"remaining_credits": 4999,
"expires": 1743659200,
"q": "michael.smith@example.com",
"name": "Michael",
"gender": "male",
"country": "US",
"total_names": 325,
"probability": 98,
"duration": "4ms"
}
응답 필드
필드 | 유형 | 설명 |
---|---|---|
status | Boolean | 요청이 성공하면 true 반환. 실패 시 오류를 확인하세요. |
used_credits | Integer | 이 요청으로 사용된 크레딧 수. |
remaining_credits | Integer | 요청 후 계정에 남은 크레딧. |
expires | Integer (timestamp) | UNIX 타임스탬프(초)로 된 패키지 만료일. |
q | String | 입력한 쿼리(이름, 이메일 또는 사용자 이름). |
name | String | 찾은 이름 또는 추출된 이름. |
gender | Enum[String] | 예측된 성별. 가능한 값: male , female , 또는 null . |
country | Enum[String] | 가장 가능성이 높은 국가 코드 (예: US , KR ). |
total_names | Integer | 예측에 사용된 샘플 수. |
probability | Integer | 성별 예측의 확률 퍼센트 (예: 50~100). |
duration | String | 요청 처리 시간 (예: 4ms ). |
sparkling unicorn
),
GET 요청 전에 반드시 URL 인코딩을 해야 합니다. 그렇지 않으면 요청이 실패하거나
다른 매개변수가 잘못 해석될 수 있습니다.
curl "https://api.genderapi.io/api?name=sparkling unicorn&key=YOUR_API_KEY"대신 다음과 같이 사용하세요:
curl "https://api.genderapi.io/api?name=sparkling%20unicorn&key=YOUR_API_KEY"또는 프로그래밍 언어에서 제공하는 URL 인코딩 기능을 사용하세요.