बेसिक उपयोग

GenderAPI आपको अलग-अलग प्रकार के इनपुट डेटा का उपयोग करके किसी व्यक्ति के लिंग को निर्धारित करने की अनुमति देता है। आप सीधे पहले नाम का विश्लेषण कर सकते हैं, या ईमेल एड्रेस और यूज़रनेम से नाम निकाल सकते हैं। यहां बताया गया है कि आप कैसे शुरू कर सकते हैं:

1. नाम से लिंग पता करें

निम्नलिखित endpoint पर एक नाम भेजें: 

https://api.genderapi.io/api

उदाहरण: 

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

आप वैकल्पिक पैरामीटर भी जोड़ सकते हैं:

  • country: भविष्यवाणी की सटीकता बढ़ाने के लिए दो-अक्षर का देश कोड भेजें ( ISO 3166-1 alpha-2 ) उदाहरण के लिए: country=TR तुर्की के लिए।
  • askToAI: अगर इसे true पर सेट किया गया है, तो API एक AI मॉडल से लिंग पता करने के लिए पूछेगी यदि नाम डेटाबेस में नहीं मिला।
  • forceToGenderize: अगर इसे true पर सेट किया गया है, तो API उन इनपुट्स के लिए भी लिंग का अनुमान लगाने की कोशिश करेगी जो असली मानव नामों जैसे नहीं लगते, जैसे कि उपनाम या फैंटेसी नाम जैसे sparkling unicorn या mystic warrior। यह यूज़रनेम का विश्लेषण करने में सहायक हो सकता है, लेकिन परिणाम कम सटीक हो सकते हैं। नोट: यह पैरामीटर ईमेल endpoint में उपलब्ध नहीं है।

पैरामीटर के साथ उदाहरण: 

curl "https://api.genderapi.io/api?name=sparkling%20unicorn&country=US&askToAI=true&forceToGenderize=true&key=YOUR_API_KEY"

2. ईमेल एड्रेस से लिंग पता करें

अगर आपके पास केवल ईमेल एड्रेस है तो इस endpoint का उपयोग करें: 

https://api.genderapi.io/api/email

उदाहरण: 

curl "https://api.genderapi.io/api/email?email=alice.smith@example.com&country=TR&askToAI=true&key=YOUR_API_KEY"

नोट: forceToGenderize पैरामीटर ईमेल endpoint के लिए उपलब्ध नहीं है क्योंकि यह endpoint पहले नाम को आंतरिक रूप से निकालता है।


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 Response

सभी endpoints के लिए 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। अगर false, तो एरर चेक करें।
used_credits Integer इस रिक्वेस्ट के लिए उपयोग किए गए क्रेडिट की संख्या।
remaining_credits Integer इस रिक्वेस्ट के बाद आपके खाते में शेष क्रेडिट।
expires Integer (timestamp) पैकेज की समाप्ति तिथि UNIX टाइमस्टैम्प (सेकंड) में।
q String आपकी इनपुट क्वेरी (नाम, ईमेल या यूज़रनेम)।
name String मिला हुआ या निकाला गया पहला नाम।
gender Enum[String] भविष्यवाणी किया गया लिंग। संभावित मान: male, female या null।
country Enum[String] सबसे संभावित देश कोड (जैसे US, DE)।
total_names Integer भविष्यवाणी के पीछे उपयोग किए गए सैंपल की संख्या।
probability Integer लिंग भविष्यवाणी की संभावना प्रतिशत (उदा. 50-100)।
duration String रिक्वेस्ट को प्रोसेस करने में लगा समय (उदा. 4ms)।
चेतावनी: अगर आपकी इनपुट वैल्यूज़ में स्पेस या विशेष अक्षर होते हैं (जैसे sparkling unicorn), तो GET रिक्वेस्ट करने से पहले हमेशा उन्हें URL-encode कर लें। अन्यथा, रिक्वेस्ट असफल हो सकती है या अन्य पैरामीटर आपकी प्रोग्रामिंग भाषा या HTTP लाइब्रेरी द्वारा गलत तरीके से समझे जा सकते हैं। 
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-encoding फंक्शन लागू करें।