الحصول على النوع من اسم المستخدم - طلب واحد

تتيح لك نقطة النهاية الحصول على النوع من اسم المستخدم تحديد نوع جنس الشخص من خلال تحليل اسم المستخدم أو اللقب. يتم إرسال جميع المعلمات عبر طلب POST بصيغة JSON. يجب عليك المصادقة باستخدام طريقة Bearer token في ترويسة Authorization.

رابط الطلب (Request URL)

POST https://api.genderapi.io/api/username

ترويسات HTTP المطلوبة

  • Content-Type: application/json
  • Authorization: Bearer YOUR_API_KEY

معاملات جسم الطلب (Request Body Parameters)

المعامل النوع إجباري الوصف
username String نعم اسم المستخدم أو اللقب المراد تحليله. يمكن أن يكون اسم حساب على وسائل التواصل الاجتماعي أو اسم شاشة أو لقب مستعار. قد يحتوي على كلمات لا تُعتبر أسماء حقيقية مثل المصطلحات الخيالية أو أسماء العلامات التجارية.
country String لا رمز البلد المكون من حرفين (ISO 3166-1 alpha-2) لتحسين دقة التوقع. على سبيل المثال: TR لتركيا.
askToAI Boolean لا إذا تم تعيينه إلى true، سيقوم الـ API بطلب تحديد النوع من نموذج ذكاء اصطناعي إذا لم يتم العثور على الاسم المستخرج في قاعدة البيانات.
forceToGenderize Boolean لا إذا تم تعيينه إلى true، سيحاول الـ API تخمين النوع حتى لأسماء المستخدمين التي لا تشبه أسماء البشر الحقيقية، مثل المصطلحات الخيالية أو الألقاب (مثال: sparkling_unicorn).

أمثلة على الطلبات


مثال cURL

curl -X POST "https://api.genderapi.io/api/username" \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer YOUR_API_KEY" \
     -d '{"username": "sparkling_unicorn", "country": "US", "askToAI": true, "forceToGenderize": true}'

مثال PHP cURL

<?php
$url = "https://api.genderapi.io/api/username";

$data = array(
    "username" => "sparkling_unicorn",
    "country" => "US",
    "askToAI" => true,
    "forceToGenderize" => true
);

$payload = json_encode($data);

$ch = curl_init($url);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
    "Content-Type: application/json",
    "Authorization: Bearer YOUR_API_KEY"
));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $payload);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>

مثال JavaScript fetch

fetch("https://api.genderapi.io/api/username", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Authorization": "Bearer YOUR_API_KEY"
  },
  body: JSON.stringify({
    username: "sparkling_unicorn",
    country: "US",
    askToAI: true,
    forceToGenderize: true
  })
})
.then(response => response.json())
.then(data => console.log(data));

مثال Python requests

import requests

url = "https://api.genderapi.io/api/username"

payload = {
    "username": "sparkling_unicorn",
    "country": "US",
    "askToAI": True,
    "forceToGenderize": True
}

headers = {
    "Content-Type": "application/json",
    "Authorization": "Bearer YOUR_API_KEY"
}

response = requests.post(url, headers=headers, json=payload)

print(response.json())

مثال على استجابة JSON

{
  "status": true,
  "used_credits": 1,
  "remaining_credits": 4999,
  "expires": 1743659200,
  "q": "sparkling_unicorn",
  "name": "Sparkling",
  "gender": "female",
  "country": "US",
  "total_names": 9876,
  "probability": 92,
  "duration": "6ms"
}

حقول الاستجابة

الحقل النوع الوصف
status Boolean يشير إلى ما إذا كانت العملية ناجحة أم لا.
used_credits Integer عدد النقاط المستهلكة لهذا الطلب.
remaining_credits Integer عدد النقاط المتبقية في حسابك بعد هذا الطلب.
expires Integer (timestamp) تاريخ انتهاء صلاحية الحزمة بصيغة UNIX timestamp.
q String استعلام الإدخال الخاص بك (اسم المستخدم المرسل).
name String الاسم المستخرج من اسم المستخدم.
gender Enum[String] الجنس المتوقع. القيم الممكنة: male أو female أو null.
country String رمز الدولة الذي تم أخذه في الاعتبار أثناء التوقع.
total_names Integer عدد العينات المستخدمة لهذا التوقع.
probability Integer نسبة الثقة في توقع النوع.
duration String مدة معالجة الطلب (مثال: 6ms).