API दस्तावेज़ीकरण V2

API v2 वाले ईमेल पते से लिंग

ईमेल नाम सिग्नल से लिंग का अनुमान लगाने के लिए GenderAPI v2 का उपयोग करें। अनुरोध और प्रतिक्रिया उदाहरण, सत्यापन, अज्ञात परिणाम और एआई विकल्प शामिल हैं।

अनुरोध भेजने से पहले

JSON को POST https://api.genderapi.io/api/v2/gender पर भेजें। Authorization: Bearer YOUR_API_KEY और Content-Type: application/json में अपनी मौजूदा API कुंजी का उपयोग करें। प्रत्येक अनुरोध को स्वतंत्र रूप से संसाधित किया जाता है।

कोड उदाहरण में अपनी भाषा चुनें. इसे चलाने से पहले प्रक्रिया वातावरण में GENDERAPI_API_KEY सेट करें। गुम या अपरिचित कुंजियाँ साझा IP परीक्षण का उपयोग कर सकती हैं, इसलिए किसी खाते को एकीकृत करते समय पुष्टि करें कि meta.access.mode api_key है।

ईमेल पते से लिंग

type का उपयोग करें: email। API पते में प्रयोग करने योग्य नाम संकेत की तलाश करता है। साझा इनबॉक्स और अपारदर्शी स्थानीय भाग अज्ञात परिणाम उत्पन्न कर सकते हैं। forceToGenderize यहां भी वैकल्पिक है; यह वास्तविक दिए गए नाम के बिना भी उपनाम से एआई अनुमान लगाने की अनुमति देता है।

प्रोग्रामिंग भाषा चुनें। अपनी API कुंजी सेट करें, फिर अपने सर्वर पर उदाहरण चलाएँ।

प्रत्येक पूर्वानुमान अनुरोध एक नया बिल योग्य ऑपरेशन है, जिसमें पुनर्प्रयास भी शामिल है। ये उदाहरण स्वचालित रूप से पुनः प्रयास नहीं करते हैं. दूसरा अनुरोध भेजने से पहले बिलिंग स्थिति जांचें।

चलाने से पहले: पहुंच और त्रुटि प्रबंधन

इन उदाहरणों को अपने सर्वर पर चलाएँ। प्रक्रिया परिवेश में GENDERAPI_API_KEY को अपनी मौजूदा API कुंजी पर सेट करें। पुष्टि करें कि meta.access.mode api_key है: एक अपरिचित कुंजी IP परीक्षण में वापस आ सकती है।

HTTP 4xx और 5xx JSON प्रतिक्रियाएँ त्रुटि निकाय को संरक्षित करती हैं और एक गैर-शून्य निकास स्थिति लौटाती हैं। पुनः प्रयास करने से पहले code, action और meta.usage.billing_status की जाँच करें।

त्रुटि और पुनः प्रयास मार्गदर्शिका →
cURL
curl --silent --show-error --fail-with-body --max-time 30 \
  --request POST 'https://api.genderapi.io/api/v2/gender' \
  --header "Authorization: Bearer ${GENDERAPI_API_KEY:?Set GENDERAPI_API_KEY}" \
  --header 'Content-Type: application/json' \
  --data '{
  "type": "email",
  "value": "alice.smith@example.com",
  "country": "US"
}'

POSIX शेल में cURL 7.76+. अपने टर्मिनल में चलाएँ. रनटाइम दस्तावेज़ीकरण

JavaScript / Node.js
// Server-side Node.js. Save as example.mjs.
const apiKey = process.env.GENDERAPI_API_KEY;
if (!apiKey) throw new Error("Set GENDERAPI_API_KEY");
const body = {
  "type": "email",
  "value": "alice.smith@example.com",
  "country": "US"
};

const response = await fetch("https://api.genderapi.io/api/v2/gender", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${apiKey}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify(body),
  signal: AbortSignal.timeout(30_000),
  redirect: "error",
});
const raw = await response.text();
if (!(response.headers.get("content-type") ?? "").includes("json")) {
  throw new Error(`HTTP ${response.status}: expected JSON; request ID ${response.headers.get("x-request-id")}`);
}
const result = JSON.parse(raw); // Also accepts application/problem+json.
if (!response.ok) {
  console.error(`HTTP ${response.status}`, result);
  process.exitCode = 1; // A retry is a new operation; inspect billing first.
} else {
  console.log(JSON.stringify(result, null, 2));
  // For batches, inspect every item: HTTP 200 may contain item errors.
}

Node.js 22+; अंतर्निर्मित फ़ेच. example.mjs के रूप में सहेजें और node example.mjs चलाएँ। रनटाइम दस्तावेज़ीकरण

Python
import json
import os
import sys
import urllib.error
import urllib.request

api_key = os.environ.get("GENDERAPI_API_KEY")
if not api_key:
    raise RuntimeError("Set GENDERAPI_API_KEY")
body = json.loads("{\"type\":\"email\",\"value\":\"alice.smith@example.com\",\"country\":\"US\"}")

class NoRedirect(urllib.request.HTTPRedirectHandler):
    def redirect_request(self, req, fp, code, msg, headers, newurl):
        return None

request = urllib.request.Request(
    "https://api.genderapi.io/api/v2/gender",
    method="POST",
    data=json.dumps(body).encode("utf-8"),
    headers={
        "Authorization": "Bearer " + api_key,
        "Content-Type": "application/json",
    },
)
opener = urllib.request.build_opener(NoRedirect())
try:
    response = opener.open(request, timeout=30)
except urllib.error.HTTPError as error:
    response = error  # Keep the Problem Details body on non-2xx responses.
with response:
    status = response.status
    raw = response.read().decode("utf-8")
    if "json" not in response.headers.get("Content-Type", ""):
        raise RuntimeError(f"HTTP {status}: expected a JSON response")
    result = json.loads(raw)
print(json.dumps(result, indent=2), file=sys.stderr if status >= 300 else sys.stdout)
if not 200 <= status < 300:
    sys.exit(1)  # Inspect code, action and billing before retrying.
# For batches, inspect every item even when HTTP status is 200.

Python 3.10+; मानक पुस्तकालय. example.py के रूप में सहेजें और python3 example.py चलाएँ। रनटाइम दस्तावेज़ीकरण

PHP
<?php
$apiKey = getenv('GENDERAPI_API_KEY');
if (!$apiKey) {
    throw new RuntimeException('Set GENDERAPI_API_KEY');
}
$body = json_decode('{"type":"email","value":"alice.smith@example.com","country":"US"}', true, 512, JSON_THROW_ON_ERROR);

$ch = curl_init('https://api.genderapi.io/api/v2/gender');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_FOLLOWLOCATION => false,
    CURLOPT_TIMEOUT => 30,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . $apiKey,
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => json_encode($body, JSON_THROW_ON_ERROR),
]);
$raw = curl_exec($ch);
if ($raw === false) {
    throw new RuntimeException(curl_error($ch));
}
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
$contentType = curl_getinfo($ch, CURLINFO_CONTENT_TYPE) ?: '';
curl_close($ch);
if (strpos($contentType, 'json') === false) {
    throw new RuntimeException("HTTP $status: expected a JSON response");
}
$result = json_decode($raw, true, 512, JSON_THROW_ON_ERROR);
$output = json_encode($result, JSON_PRETTY_PRINT | JSON_THROW_ON_ERROR) . PHP_EOL;
if ($status < 200 || $status >= 300) {
    fwrite(STDERR, $output); // Preserve the Problem Details body.
    exit(1);
}
echo $output;
// For batches, inspect every item; HTTP 200 can contain item errors.

PHP 8+ cURL एक्सटेंशन के साथ. example.php के रूप में सहेजें और php example.php चलाएँ। रनटाइम दस्तावेज़ीकरण

Java
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.nio.charset.StandardCharsets;
import java.time.Duration;

public class GenderApiExample {
    private static String requiredEnv(String name) {
        String value = System.getenv(name);
        if (value == null || value.isBlank()) throw new IllegalStateException("Set " + name);
        return value;
    }

    public static void main(String[] args) throws Exception {
        String apiKey = requiredEnv("GENDERAPI_API_KEY");
        String body = "{\"type\":\"email\",\"value\":\"alice.smith@example.com\",\"country\":\"US\"}";
        HttpClient client = HttpClient.newBuilder()
            .connectTimeout(Duration.ofSeconds(10))
            .followRedirects(HttpClient.Redirect.NEVER)
            .build();
        HttpRequest request = HttpRequest.newBuilder(URI.create("https://api.genderapi.io/api/v2/gender"))
            .timeout(Duration.ofSeconds(30))
            .header("Authorization", "Bearer " + apiKey)
            .header("Content-Type", "application/json")
            .POST(HttpRequest.BodyPublishers.ofString(body, StandardCharsets.UTF_8))
            .build();
        HttpResponse<String> response = client.send(request,
            HttpResponse.BodyHandlers.ofString(StandardCharsets.UTF_8));
        if (!response.headers().firstValue("content-type").orElse("").contains("json")) {
            throw new IllegalStateException("HTTP " + response.statusCode() + ": expected JSON");
        }
        // JSON text; parse with your application's JSON library when integrating.
        if (response.statusCode() < 200 || response.statusCode() >= 300) {
            System.err.println(response.body()); // Includes Problem Details.
            System.exit(1);
        }
        System.out.println(response.body());
        // For batches, inspect each item's data or error, including on HTTP 200.
    }
}

Java 17+; मानक HTTP क्लाइंट. GenderApiExample.java के रूप में सहेजें और java GenderApiExample.java चलाएँ। रनटाइम दस्तावेज़ीकरण

C# / .NET
using System;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Text.Json;

string RequiredEnv(string name) =>
    !string.IsNullOrWhiteSpace(Environment.GetEnvironmentVariable(name))
        ? Environment.GetEnvironmentVariable(name)!
        : throw new InvalidOperationException($"Set {name}");

var apiKey = RequiredEnv("GENDERAPI_API_KEY");
using var handler = new HttpClientHandler { AllowAutoRedirect = false };
using var client = new HttpClient(handler) { Timeout = TimeSpan.FromSeconds(30) };
using var request = new HttpRequestMessage(HttpMethod.Post, "https://api.genderapi.io/api/v2/gender");
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", apiKey);
request.Content = new StringContent("{\"type\":\"email\",\"value\":\"alice.smith@example.com\",\"country\":\"US\"}", Encoding.UTF8, "application/json");

using var response = await client.SendAsync(request);
var raw = await response.Content.ReadAsStringAsync();
if (!(response.Content.Headers.ContentType?.MediaType?.Contains("json") ?? false))
    throw new InvalidOperationException($"HTTP {(int)response.StatusCode}: expected JSON");
using var result = JsonDocument.Parse(raw);
if (!response.IsSuccessStatusCode)
{
    Console.Error.WriteLine(result.RootElement); // Preserve Problem Details.
    Environment.ExitCode = 1;
}
else
{
    Console.WriteLine(result.RootElement);
    // For batches, inspect every item even on HTTP 200.
}

.NET 8+ कंसोल एप्लिकेशन. कंसोल प्रोजेक्ट में Program.cs के रूप में उपयोग करें, फिर dotnet run चलाएँ। रनटाइम दस्तावेज़ीकरण

Go
package main

import (
    "encoding/json"
    "fmt"
    "io"
    "net/http"
    "os"
    "strings"
    "time"
)

func requiredEnv(name string) string {
    value := os.Getenv(name)
    if value == "" { panic("Set " + name) }
    return value
}

func run() error {
    apiKey := requiredEnv("GENDERAPI_API_KEY")
    body := "{\"type\":\"email\",\"value\":\"alice.smith@example.com\",\"country\":\"US\"}"
    request, err := http.NewRequest("POST", "https://api.genderapi.io/api/v2/gender", strings.NewReader(body))
    if err != nil { return err }
    request.Header.Set("Authorization", "Bearer " + apiKey)
    request.Header.Set("Content-Type", "application/json")
    client := &http.Client{
        Timeout: 30 * time.Second,
        CheckRedirect: func(req *http.Request, via []*http.Request) error {
            return http.ErrUseLastResponse
        },
    }
    response, err := client.Do(request)
    if err != nil { return err }
    defer response.Body.Close()
    raw, err := io.ReadAll(response.Body)
    if err != nil { return err }
    if !strings.Contains(response.Header.Get("Content-Type"), "json") || !json.Valid(raw) {
        return fmt.Errorf("HTTP %d: expected a JSON response", response.StatusCode)
    }
    if response.StatusCode < 200 || response.StatusCode >= 300 {
        return fmt.Errorf("HTTP %d: %s", response.StatusCode, raw)
    }
    fmt.Println(string(raw))
    // For batches, inspect every item even on HTTP 200.
    return nil
}

func main() {
    if err := run(); err != nil {
        fmt.Fprintln(os.Stderr, err) // Keep Problem Details for error handling.
        os.Exit(1)
    }
}

Go 1.22+; मानक पुस्तकालय. main.go के रूप में सहेजें और go run main.go चलाएँ। रनटाइम दस्तावेज़ीकरण

उदाहरण प्रतिक्रिया

यह सिंथेटिक प्रतिक्रिया JSON आकार को दर्शाती है, न कि मापी गई सटीकता या गारंटीकृत लाइव परिणाम को। यह IP-ट्रायल एक्सेस दिखाता है; एक प्रमाणित ऑपरेशन रिपोर्ट meta.access.mode: api_key और null केवल परीक्षण कोटा फ़ील्ड। अनुमान के लिए डेटा पढ़ें और ऑपरेशन के बिलिंग परिणाम के लिए meta.usage पढ़ें।

उदाहरणात्मक JSON प्रतिक्रिया
{
  "data": {
    "input": {
      "type": "email",
      "value": "alice.smith@example.com",
      "country": "US"
    },
    "name": "alice",
    "gender": "female",
    "country": "US",
    "confidence": 0.9,
    "confidence_kind": "observed_frequency",
    "sample_count": 100,
    "source": "dataset",
    "result_status": "identified",
    "reason": null,
    "country_source": "dataset",
    "match": {
      "name": "alice",
      "method": "normalized",
      "scope": "country",
      "country": "US"
    }
  },
  "meta": {
    "request_id": "11111111-1111-4111-8111-111111111111",
    "duration_ms": 12,
    "access": {
      "mode": "ip_trial",
      "reason": "api_key_missing"
    },
    "usage": {
      "charged_credits": 1,
      "remaining_credits": 9,
      "billing_status": "confirmed",
      "resets_at": "2026-09-26T12:00:00.000Z",
      "limit": 10,
      "period_seconds": 86400
    }
  }
}

ईमेल सत्यापन और नाम संकेत

value एक वाक्यात्मक रूप से मान्य ईमेल पता होना चाहिए। अमान्य सिंटैक्स बिलिंग से पहले HTTP 422 लौटाता है। सिंटैक्स सत्यापन यह स्थापित नहीं करता है कि मेलबॉक्स मौजूद है या किसी विशेष व्यक्ति का है।

पते में एक पहचानने योग्य व्यक्तिगत नाम डेटासेट से मेल खा सकता है। साझा मेलबॉक्स, भूमिका पते और अपारदर्शी स्थानीय भाग लिंग लौटा सकते हैं: null। डिफ़ॉल्ट रूप से, एक अनसुलझा एकल लुकअप एक सफल अज्ञात परिणाम सहित कुल 1 क्रेडिट के लिए सामान्य एआई फ़ॉलबैक का उपयोग करता है।

यदि आप डेटासेट अनसुलझा होने पर उपनाम-जागरूक एआई अनुमान चाहते हैं तो forceToGenderize: true का उपयोग करें। यदि AI का उपयोग किया जाता है तो समाधान किए गए डेटासेट परिणाम के लिए इसकी लागत 1 क्रेडिट या कुल 2 क्रेडिट है। API अभी भी null लौटा सकता है। ईमेल डोमेन व्यक्ति के स्थान का प्रमाण नहीं है; प्रासंगिक संदर्भ ज्ञात होने पर ही किसी देश को आपूर्ति करें।

संबंधित मार्गदर्शिकाएँ