API-DOCUMENTATIE

=== AI IMPLEMENTATION INSTRUCTIONS ===

ENDPOINT: Eenvoudig gebruik - geslacht opvragen op naam
PURPOSE: Dit is de makkelijkste manier om een genderbepaling aan te vragen. Elke response is JSON-gecodeerd.

--- API DETAILS ---
Method: GET
URL: https://gender-api.com/get?name=Elizabeth&key=YOUR_API_KEY

--- AUTHENTICATION ---

--- REQUEST PARAMETERS ---

Parameter: name
  Type: String
  Required: REQUIRED (for this endpoint)
  Description: Naam om op te zoeken

Parameter: key
  Type: String
  Required: REQUIRED
  Description: Je API-sleutel

--- EXPECTED RESPONSE ---

Response (JSON):
{"name":"diana","name_sanitized":"Diana","gender":"female","samples":523,"accuracy":93,"duration":"41ms","credits_used":1}

--- RESPONSE FIELDS ---

Field: name
  Type: String
  Description: Ingevoerde naam in kleine letters

Field: name_sanitized
  Type: String
  Description: De naam nadat we onze normalisator erop hebben toegepast

Field: gender
  Type: String
  Description: Mogelijke waarden: male, female, unknown

Field: samples
  Type: Integer
  Description: Aantal records in onze database dat overeenkomt met je verzoek

Field: accuracy
  Type: Integer
  Description: Deze waarde bepaalt de betrouwbaarheid van onze database. Een waarde van 100 betekent dat de resultaten van je geslachtsverzoek 100% nauwkeurig zijn

Field: duration
  Type: String
  Description: Tijd die de server nodig had om het verzoek te verwerken

Field: credits_used
  Type: Integer
  Description: Het aantal verzoeken dat voor deze query is gebruikt

--- IMPLEMENTATION NOTES ---

1. Make sure to replace placeholder values:
   - Replace '' with your actual API key
   - Replace domain placeholders with the actual API domain

2. Handle errors appropriately:
   - Check HTTP status codes
   - Parse error responses
   - Implement retry logic for transient failures

3. Best Practices:
   - Store API keys securely (use environment variables)
   - Implement rate limiting on your side
   - Cache responses when appropriate
   - Use HTTPS for all requests
   - Set appropriate timeout values

4. RECOMMENDED: Implement the Statistics Endpoint
   - The statistics endpoint allows users to monitor their credit usage
   - Users can see how many credits they have used and how many are left
   - This helps prevent unexpected service interruptions
   - API v1: GET /get-stats?key=YOUR_API_KEY
   - API v2: GET /v2/statistic (with Authorization Bearer token)
   - Display remaining credits in your application's UI
   - Consider adding alerts when credits are running low

--- IMPLEMENTATION TEMPLATE ---

// Example implementation in cURL:
curl -X GET \
  'https://gender-api.com/get?name=Elizabeth&key=YOUR_API_KEY' \

--- CREDIT USAGE ---
Required Requests: 1

=== END OF INSTRUCTIONS ===

=== AI IMPLEMENTATION INSTRUCTIONS ===

ENDPOINT: Lokalisatie - Landcode (v1)
PURPOSE: Maak je verzoek nauwkeuriger door je query te lokaliseren met landcodes.

--- API DETAILS ---
Method: GET
URL: https://gender-api.com/get?name=Andrea&country=IT&key=YOUR_API_KEY

--- AUTHENTICATION ---

--- REQUEST PARAMETERS ---

Parameter: name
  Type: String
  Required: REQUIRED (for this endpoint)
  Description: Naam om op te zoeken

Parameter: country
  Type: String
  Required: OPTIONAL
  Description: ISO 3166 ALPHA-2-landcode

Parameter: key
  Type: String
  Required: REQUIRED
  Description: Je API-sleutel

--- EXPECTED RESPONSE ---

Response (JSON):
//In Italy, Andrea is male. 
{"name":"andrea","name_sanitized":"Andrea","country":"IT","gender":"male","samples":1068,"accuracy":95,"duration":"15ms","credits_used":1}

//In Germany, Andrea is female. 
{"name":"andrea","name_sanitized":"Andrea","country":"DE","gender":"female","samples":4089,"accuracy":85,"duration":"33ms","credits_used":1}

--- RESPONSE FIELDS ---

Field: name
  Type: String
  Description: Ingevoerde naam in kleine letters

Field: name_sanitized
  Type: String
  Description: De naam nadat we onze normalisator erop hebben toegepast

Field: country
  Type: String
  Description: Ingediende landcode

Field: gender
  Type: String
  Description: Mogelijke waarden: male, female, unknown

Field: samples
  Type: Integer
  Description: Aantal records in onze database dat overeenkomt met je verzoek

Field: accuracy
  Type: Integer
  Description: Deze waarde bepaalt de betrouwbaarheid van onze database. Een waarde van 100 betekent dat de resultaten van je geslachtsverzoek 100% nauwkeurig zijn

Field: duration
  Type: String
  Description: Tijd die de server nodig had om het verzoek te verwerken

Field: credits_used
  Type: Integer
  Description: Het aantal verzoeken dat voor deze query is gebruikt

--- IMPLEMENTATION NOTES ---

1. Make sure to replace placeholder values:
   - Replace '' with your actual API key
   - Replace domain placeholders with the actual API domain

2. Handle errors appropriately:
   - Check HTTP status codes
   - Parse error responses
   - Implement retry logic for transient failures

3. Best Practices:
   - Store API keys securely (use environment variables)
   - Implement rate limiting on your side
   - Cache responses when appropriate
   - Use HTTPS for all requests
   - Set appropriate timeout values

4. RECOMMENDED: Implement the Statistics Endpoint
   - The statistics endpoint allows users to monitor their credit usage
   - Users can see how many credits they have used and how many are left
   - This helps prevent unexpected service interruptions
   - API v1: GET /get-stats?key=YOUR_API_KEY
   - API v2: GET /v2/statistic (with Authorization Bearer token)
   - Display remaining credits in your application's UI
   - Consider adding alerts when credits are running low

--- IMPLEMENTATION TEMPLATE ---

// Example implementation in cURL:
curl -X GET \
  'https://gender-api.com/get?name=Andrea&country=IT&key=YOUR_API_KEY' \

--- CREDIT USAGE ---
Required Requests: 1

=== END OF INSTRUCTIONS ===

=== AI IMPLEMENTATION INSTRUCTIONS ===

ENDPOINT: Lokalisatie - Land op basis van IP (v1)
PURPOSE: Kies het land van je klant op basis van zijn/haar IP-adres.

--- API DETAILS ---
Method: GET
URL: https://gender-api.com/get?name=john&ip=54.201.16.177&key=YOUR_API_KEY

--- AUTHENTICATION ---

--- REQUEST PARAMETERS ---

Parameter: name
  Type: String
  Required: REQUIRED (for this endpoint)
  Description: Naam om op te zoeken

Parameter: ip
  Type: String
  Required: OPTIONAL
  Description: Geldig IP-adres

Parameter: key
  Type: String
  Required: REQUIRED
  Description: Je API-sleutel

--- EXPECTED RESPONSE ---

Response (JSON):
{"name":"john","name_sanitized":"John","country":"US","gender":"male","samples":9991,"accuracy":99,"duration":"44ms","credits_used":1}

{"name":"tanja","name_sanitized":"Tanja","country":"DE","gender":"female","samples":143,"accuracy":97,"duration":"508ms","credits_used":1}

--- RESPONSE FIELDS ---

Field: name
  Type: String
  Description: Ingevoerde naam in kleine letters

Field: name_sanitized
  Type: String
  Description: De naam nadat we onze normalisator erop hebben toegepast

Field: country
  Type: String
  Description: Ingediende landcode

Field: gender
  Type: String
  Description: Mogelijke waarden: male, female, unknown

Field: samples
  Type: Integer
  Description: Aantal records in onze database dat overeenkomt met je verzoek

Field: accuracy
  Type: Integer
  Description: Deze waarde bepaalt de betrouwbaarheid van onze database. Een waarde van 100 betekent dat de resultaten van je geslachtsverzoek 100% nauwkeurig zijn

Field: duration
  Type: String
  Description: Tijd die de server nodig had om het verzoek te verwerken

Field: credits_used
  Type: Integer
  Description: Het aantal verzoeken dat voor deze query is gebruikt

--- IMPLEMENTATION NOTES ---

1. Make sure to replace placeholder values:
   - Replace '' with your actual API key
   - Replace domain placeholders with the actual API domain

2. Handle errors appropriately:
   - Check HTTP status codes
   - Parse error responses
   - Implement retry logic for transient failures

3. Best Practices:
   - Store API keys securely (use environment variables)
   - Implement rate limiting on your side
   - Cache responses when appropriate
   - Use HTTPS for all requests
   - Set appropriate timeout values

4. RECOMMENDED: Implement the Statistics Endpoint
   - The statistics endpoint allows users to monitor their credit usage
   - Users can see how many credits they have used and how many are left
   - This helps prevent unexpected service interruptions
   - API v1: GET /get-stats?key=YOUR_API_KEY
   - API v2: GET /v2/statistic (with Authorization Bearer token)
   - Display remaining credits in your application's UI
   - Consider adding alerts when credits are running low

--- IMPLEMENTATION TEMPLATE ---

// Example implementation in cURL:
curl -X GET \
  'https://gender-api.com/get?name=john&ip=54.201.16.177&key=YOUR_API_KEY' \

--- CREDIT USAGE ---
Required Requests: 1

=== END OF INSTRUCTIONS ===

=== AI IMPLEMENTATION INSTRUCTIONS ===

ENDPOINT: Lokalisatie - Browsertaal (v1)
PURPOSE: Kies het land van je klant op basis van zijn/haar browsertaal voor automatische lokalisatie.

--- API DETAILS ---
Method: GET
URL: https://gender-api.com/get?name=john&locale=en_US&key=YOUR_API_KEY

--- AUTHENTICATION ---

--- REQUEST PARAMETERS ---

Parameter: name
  Type: String
  Required: REQUIRED (for this endpoint)
  Description: Naam om op te zoeken

Parameter: locale
  Type: String
  Required: OPTIONAL
  Description: Browser locale

Parameter: key
  Type: String
  Required: REQUIRED
  Description: Je API-sleutel

--- EXPECTED RESPONSE ---

Response (JSON):
{"name":"john","name_sanitized":"John","country":"US","gender":"male","samples":991,"accuracy":99,"duration":"47ms","credits_used":1}

{"name":"tanja","name_sanitized":"Tanja","country":"DE","gender":"female","samples":143,"accuracy":97,"duration":"99ms","credits_used":1}

--- RESPONSE FIELDS ---

Field: name
  Type: String
  Description: Ingevoerde naam in kleine letters

Field: name_sanitized
  Type: String
  Description: De naam nadat we onze normalisator erop hebben toegepast

Field: country
  Type: String
  Description: Ingediende landcode

Field: gender
  Type: String
  Description: Mogelijke waarden: male, female, unknown

Field: samples
  Type: Integer
  Description: Aantal records in onze database dat overeenkomt met je verzoek

Field: accuracy
  Type: Integer
  Description: Deze waarde bepaalt de betrouwbaarheid van onze database. Een waarde van 100 betekent dat de resultaten van je geslachtsverzoek 100% nauwkeurig zijn

Field: duration
  Type: String
  Description: Tijd die de server nodig had om het verzoek te verwerken

Field: credits_used
  Type: Integer
  Description: Het aantal verzoeken dat voor deze query is gebruikt

--- IMPLEMENTATION NOTES ---

1. Make sure to replace placeholder values:
   - Replace '' with your actual API key
   - Replace domain placeholders with the actual API domain

2. Handle errors appropriately:
   - Check HTTP status codes
   - Parse error responses
   - Implement retry logic for transient failures

3. Best Practices:
   - Store API keys securely (use environment variables)
   - Implement rate limiting on your side
   - Cache responses when appropriate
   - Use HTTPS for all requests
   - Set appropriate timeout values

4. RECOMMENDED: Implement the Statistics Endpoint
   - The statistics endpoint allows users to monitor their credit usage
   - Users can see how many credits they have used and how many are left
   - This helps prevent unexpected service interruptions
   - API v1: GET /get-stats?key=YOUR_API_KEY
   - API v2: GET /v2/statistic (with Authorization Bearer token)
   - Display remaining credits in your application's UI
   - Consider adding alerts when credits are running low

--- IMPLEMENTATION TEMPLATE ---

// Example implementation in cURL:
curl -X GET \
  'https://gender-api.com/get?name=john&locale=en_US&key=YOUR_API_KEY' \

--- CREDIT USAGE ---
Required Requests: 1

=== END OF INSTRUCTIONS ===

=== AI IMPLEMENTATION INSTRUCTIONS ===

ENDPOINT: Meerdere namen opvragen (v1)
PURPOSE: Haal meerdere namen op in één verzoek met puntkomma-gescheiden waarden.

--- API DETAILS ---
Method: GET
URL: https://gender-api.com/get?name=lisa;jess;thomas&multi=true&key=YOUR_API_KEY

--- AUTHENTICATION ---

--- REQUEST PARAMETERS ---

Parameter: name
  Type: String
  Required: REQUIRED (for this endpoint)
  Description: Lijst met namen om op te zoeken, gescheiden door puntkomma's

Parameter: country
  Type: String
  Required: OPTIONAL
  Description: Lijst met landcodes gescheiden door puntkomma's. De landcodes moeten in dezelfde volgorde als de namen zijn. Als er slechts één landcode wordt verstrekt, wordt deze code voor alle namen gebruikt.

Parameter: multi
  Type: Boolean (true|false)
  Required: REQUIRED (for this endpoint)
  Description: Geeft de API de opdracht om het resultaat als een array terug te geven

Parameter: key
  Type: String
  Required: REQUIRED
  Description: Je API-sleutel

--- EXPECTED RESPONSE ---

Response (JSON):
{"name":"lisa;jess;thomas","result":[
{"name":"lisa","name_sanitized":"Lisa","country":"","gender":"female","samples":806,"accuracy":98},
{"name":"jess","name_sanitized":"Jess","country":"","gender":"female","samples":28,"accuracy":75},
{"name":"thomas","name_sanitized":"Thomas","country":"","gender":"male","samples":2239,"accuracy":99}],
"country":"","duration":"425ms","credits_used":3}

{"name":"anna;jack;stephen","result":[
{"name":"anna","name_sanitized":"Anna","country":"DE","gender":"female","samples":1245,"accuracy":98},
{"name":"jack","name_sanitized":"Jack","country":"US","gender":"male","samples":667,"accuracy":90},
{"name":"stephen","name_sanitized":"Stephen","country":"CA","gender":"male","samples":77,"accuracy":82}],
"country":"DE;US;CA","duration":"668ms","credits_used":3}

--- RESPONSE FIELDS ---

Field: name
  Type: String
  Description: Ingestuurde namen in kleine letters. Het maximale aantal namen is beperkt tot 100.

Field: result
  Type: Array
  Description: Zie de respons onder "Eenvoudig gebruik"

Field: country
  Type: String
  Description: Ingestuurde lijst van landcodes

Field: duration
  Type: String
  Description: Tijd die de server nodig had om het verzoek te verwerken

Field: credits_used
  Type: Integer
  Description: Het aantal verzoeken dat voor deze query is gebruikt

--- IMPLEMENTATION NOTES ---

1. Make sure to replace placeholder values:
   - Replace '' with your actual API key
   - Replace domain placeholders with the actual API domain

2. Handle errors appropriately:
   - Check HTTP status codes
   - Parse error responses
   - Implement retry logic for transient failures

3. Best Practices:
   - Store API keys securely (use environment variables)
   - Implement rate limiting on your side
   - Cache responses when appropriate
   - Use HTTPS for all requests
   - Set appropriate timeout values

4. RECOMMENDED: Implement the Statistics Endpoint
   - The statistics endpoint allows users to monitor their credit usage
   - Users can see how many credits they have used and how many are left
   - This helps prevent unexpected service interruptions
   - API v1: GET /get-stats?key=YOUR_API_KEY
   - API v2: GET /v2/statistic (with Authorization Bearer token)
   - Display remaining credits in your application's UI
   - Consider adding alerts when credits are running low

--- IMPLEMENTATION TEMPLATE ---

// Example implementation in cURL:
curl -X GET \
  'https://gender-api.com/get?name=lisa;jess;thomas&multi=true&key=YOUR_API_KEY' \

--- CREDIT USAGE ---
Required Requests: 1 credit per naam

=== END OF INSTRUCTIONS ===

=== AI IMPLEMENTATION INSTRUCTIONS ===

ENDPOINT: E-mailadresquery (v1)
PURPOSE: Vraag het geslacht op met een e-mailadres dat een voornaam bevat.

--- API DETAILS ---
Method: GET
URL: https://gender-api.com/get?email=markus.johnson@gmail.com&key=YOUR_API_KEY

--- AUTHENTICATION ---

--- REQUEST PARAMETERS ---

Parameter: name
  Type: String
  Required: REQUIRED (for this endpoint)
  Description: Naam om op te zoeken

Parameter: email
  Type: String
  Required: REQUIRED (for this endpoint)
  Description: Email address

Parameter: key
  Type: String
  Required: REQUIRED
  Description: Je API-sleutel

--- EXPECTED RESPONSE ---

Response (JSON):
{"email":"markus.johnson@gmail.com","last_name":"Johnson","first_name":"Markus","mail_provider":"gmail","name":"markus","name_sanitized":"Markus","country":"","gender":"male","samples":150,"accuracy":99,"duration":"669ms","credits_used":1}

{"email":"jack.meyer@gmail.com","last_name":"Meyer","first_name":"Jack","mail_provider":"gmail","name":"jack","name_sanitized":"Jack","country":"US","gender":"male","samples":667,"accuracy":90,"duration":"1011ms","credits_used":1}

--- RESPONSE FIELDS ---

Field: email
  Type: String
  Description: Het ingediende e-mailadres

Field: last_name
  Type: String
  Description: De gevonden achternaam

Field: first_name
  Type: String
  Description: De gevonden voornaam

Field: mail_provider
  Type: String
  Description: Naam van de e-mailprovider

Field: name
  Type: String
  Description: Voornaam gevonden in kleine letters

Field: name_sanitized
  Type: String
  Description: De naam nadat we onze normalisator erop hebben toegepast

Field: country
  Type: String
  Description: Ingediende landcode

Field: gender
  Type: String
  Description: Mogelijke waarden: male, female, unknown

Field: samples
  Type: Integer
  Description: Aantal records in onze database dat overeenkomt met je verzoek

Field: accuracy
  Type: Integer
  Description: Deze waarde bepaalt de betrouwbaarheid van onze database. Een waarde van 100 betekent dat de resultaten van je geslachtsverzoek 100% nauwkeurig zijn

Field: duration
  Type: String
  Description: Tijd die de server nodig had om het verzoek te verwerken

Field: credits_used
  Type: Integer
  Description: Het aantal verzoeken dat voor deze query is gebruikt

--- IMPLEMENTATION NOTES ---

1. Make sure to replace placeholder values:
   - Replace '' with your actual API key
   - Replace domain placeholders with the actual API domain

2. Handle errors appropriately:
   - Check HTTP status codes
   - Parse error responses
   - Implement retry logic for transient failures

3. Best Practices:
   - Store API keys securely (use environment variables)
   - Implement rate limiting on your side
   - Cache responses when appropriate
   - Use HTTPS for all requests
   - Set appropriate timeout values

4. RECOMMENDED: Implement the Statistics Endpoint
   - The statistics endpoint allows users to monitor their credit usage
   - Users can see how many credits they have used and how many are left
   - This helps prevent unexpected service interruptions
   - API v1: GET /get-stats?key=YOUR_API_KEY
   - API v2: GET /v2/statistic (with Authorization Bearer token)
   - Display remaining credits in your application's UI
   - Consider adding alerts when credits are running low

--- IMPLEMENTATION TEMPLATE ---

// Example implementation in cURL:
curl -X GET \
  'https://gender-api.com/get?email=markus.johnson@gmail.com&key=YOUR_API_KEY' \

--- CREDIT USAGE ---
Required Requests: 1

=== END OF INSTRUCTIONS ===

=== AI IMPLEMENTATION INSTRUCTIONS ===

ENDPOINT: Voornaam en achternaam splitsen (v1)
PURPOSE: Haal voornaam en achternaam uit één gecombineerd veld en bepaal het geslacht.

--- API DETAILS ---
Method: GET
URL: https://gender-api.com/get?split=theresa%20miller&key=YOUR_API_KEY

--- AUTHENTICATION ---

--- REQUEST PARAMETERS ---

Parameter: split
  Type: String
  Required: REQUIRED (for this endpoint)
  Description: Volledige naam

Parameter: country
  Type: String
  Required: OPTIONAL
  Description: ISO 3166 ALPHA-2-landcode

Parameter: strict
  Type: Boolean (true|false)
  Required: OPTIONAL
  Description: Als de strikte modus is ingeschakeld, retourneren we null in het veld last_name wanneer de achternaam niet in onze database te vinden is. Als de strikte modus is uitgeschakeld, proberen we de achternaam alsnog te bepalen, ook als die niet in onze database staat

Parameter: key
  Type: String
  Required: REQUIRED
  Description: Je API-sleutel

--- EXPECTED RESPONSE ---

Response (JSON):
{"last_name":"Miller","first_name":"Theresa","strict":false,"name":"theresa","name_sanitized":"Theresa","country":"","gender":"female","samples":70,"accuracy":74,"duration":"56ms","credits_used":1}

{"last_name":"Johnson","first_name":"Tim","strict":false,"name":"tim","name_sanitized":"Tim","country":"US","gender":"male","samples":7,"accuracy":100,"duration":"58ms","credits_used":1}

{"last_name":"","first_name":"Markus Stefan","strict":true,"name":"markus","name_sanitized":"Markus","country":"","gender":"male","samples":150,"accuracy":99,"duration":"85ms","credits_used":1}

--- RESPONSE FIELDS ---

Field: last_name
  Type: String
  Description: De gevonden achternaam

Field: first_name
  Type: String
  Description: De gevonden voornaam

Field: strict
  Type: Boolean
  Description: true als de strikte modus is ingeschakeld

Field: name
  Type: String
  Description: Voornaam gevonden in kleine letters

Field: name_sanitized
  Type: String
  Description: De naam nadat we onze normalisator erop hebben toegepast

Field: country
  Type: String
  Description: Ingediende landcode

Field: gender
  Type: String
  Description: Mogelijke waarden: male, female, unknown

Field: samples
  Type: Integer
  Description: Aantal records in onze database dat overeenkomt met je verzoek

Field: accuracy
  Type: Integer
  Description: Deze waarde bepaalt de betrouwbaarheid van onze database. Een waarde van 100 betekent dat de resultaten van je geslachtsverzoek 100% nauwkeurig zijn

Field: duration
  Type: String
  Description: Tijd die de server nodig had om het verzoek te verwerken

Field: credits_used
  Type: Integer
  Description: Het aantal verzoeken dat voor deze query is gebruikt

--- IMPLEMENTATION NOTES ---

1. Make sure to replace placeholder values:
   - Replace '' with your actual API key
   - Replace domain placeholders with the actual API domain

2. Handle errors appropriately:
   - Check HTTP status codes
   - Parse error responses
   - Implement retry logic for transient failures

3. Best Practices:
   - Store API keys securely (use environment variables)
   - Implement rate limiting on your side
   - Cache responses when appropriate
   - Use HTTPS for all requests
   - Set appropriate timeout values

4. RECOMMENDED: Implement the Statistics Endpoint
   - The statistics endpoint allows users to monitor their credit usage
   - Users can see how many credits they have used and how many are left
   - This helps prevent unexpected service interruptions
   - API v1: GET /get-stats?key=YOUR_API_KEY
   - API v2: GET /v2/statistic (with Authorization Bearer token)
   - Display remaining credits in your application's UI
   - Consider adding alerts when credits are running low

--- IMPLEMENTATION TEMPLATE ---

// Example implementation in cURL:
curl -X GET \
  'https://gender-api.com/get?split=theresa%20miller&key=YOUR_API_KEY' \

--- CREDIT USAGE ---
Required Requests: 1

=== END OF INSTRUCTIONS ===

=== AI IMPLEMENTATION INSTRUCTIONS ===

ENDPOINT: Statistieken ophalen (v1)
PURPOSE: Haal statistieken van je account op, waaronder resterende requests en gebruik.

--- API DETAILS ---
Method: GET
URL: https://gender-api.com/get-stats?&key=YOUR_API_KEY

--- AUTHENTICATION ---

--- REQUEST PARAMETERS ---

Parameter: key
  Type: String
  Required: REQUIRED
  Description: Je API-sleutel

--- EXPECTED RESPONSE ---

Response (JSON):
{"key":"yourkey","is_limit_reached":false,"remaining_requests":43566,"amount_month_start":90000,"amount_month_bought":100000,"duration":"37ms"}

--- RESPONSE FIELDS ---

Field: key
  Type: String
  Description: Je API-sleutel

Field: is_limit_reached
  Type: Boolean
  Description: Geeft true terug als er geen verzoeken meer over zijn

Field: remaining_requests
  Type: Integer
  Description: Telt de resterende verzoeken

Field: amount_month_start
  Type: Integer
  Description: Verzoeken aan het begin van de maand

Field: amount_month_bought
  Type: Integer
  Description: Verzoeken die deze maand zijn gekocht

Field: duration
  Type: String
  Description: Tijd die de server nodig had om het verzoek te verwerken

--- IMPLEMENTATION NOTES ---

1. Make sure to replace placeholder values:
   - Replace '' with your actual API key
   - Replace domain placeholders with the actual API domain

2. Handle errors appropriately:
   - Check HTTP status codes
   - Parse error responses
   - Implement retry logic for transient failures

3. Best Practices:
   - Store API keys securely (use environment variables)
   - Implement rate limiting on your side
   - Cache responses when appropriate
   - Use HTTPS for all requests
   - Set appropriate timeout values

4. RECOMMENDED: Implement the Statistics Endpoint
   - The statistics endpoint allows users to monitor their credit usage
   - Users can see how many credits they have used and how many are left
   - This helps prevent unexpected service interruptions
   - API v1: GET /get-stats?key=YOUR_API_KEY
   - API v2: GET /v2/statistic (with Authorization Bearer token)
   - Display remaining credits in your application's UI
   - Consider adding alerts when credits are running low

--- IMPLEMENTATION TEMPLATE ---

// Example implementation in cURL:
curl -X GET \
  'https://gender-api.com/get-stats?&key=YOUR_API_KEY' \

--- CREDIT USAGE ---
Required Requests: 0 verzoeken

=== END OF INSTRUCTIONS ===

=== AI IMPLEMENTATION INSTRUCTIONS ===

ENDPOINT: Land van herkomst ophalen (v1)
PURPOSE: Bepaal het land van herkomst van een voornaam met waarschijnlijkheidsscores.

--- API DETAILS ---
Method: GET
URL: https://gender-api.com/get-country-of-origin?name=Markus&key=YOUR_API_KEY

--- AUTHENTICATION ---

--- REQUEST PARAMETERS ---

Parameter: name
  Type: String
  Required: REQUIRED (for this endpoint)
  Description: Naam om op te zoeken

Parameter: key
  Type: String
  Required: REQUIRED
  Description: Je API-sleutel

--- EXPECTED RESPONSE ---

Response (JSON):
{
    "name": "markus",
    "country_of_origin": [
        {
            "countryName": "Finland",
            "country": "FI",
            "probability": 0.74,
            "continentalRegion": "Europe",
            "statisticalRegion": "Northern Europe"
        },
        {
            "countryName": "Sweden",
            "country": "SE",
            "probability": 0.22,
            "continentalRegion": "Europe",
            "statisticalRegion": "Northern Europe"
        },
        {
            "countryName": "Other",
            "country": "--",
            "probability": 0.04
        }
    ],
    "name_sanitized": "Markus",
    "gender": "male",
    "samples": 150,
    "accuracy": 99,
    "country_of_origin_map_url": "https://gender-api.com/en/map/37/3da90b0fe64e5102"
    "credits_used": 2,
    "duration": "165ms"
}

--- RESPONSE FIELDS ---

Field: name
  Type: String
  Description: Ingevoerde naam in kleine letters

Field: name_sanitized
  Type: String
  Description: De naam nadat we onze normalisator erop hebben toegepast

Field: gender
  Type: String
  Description: Mogelijke waarden: male, female, unknown

Field: samples
  Type: Integer
  Description: Aantal records in onze database dat overeenkomt met je verzoek

Field: accuracy
  Type: Integer
  Description: Deze waarde bepaalt de betrouwbaarheid van onze database. Een waarde van 100 betekent dat de resultaten van je geslachtsverzoek 100% nauwkeurig zijn

Field: country_of_origin
  Type: Array
  Description: Top 25 landen van herkomst. Zie "%sVolledige lijst van mogelijke landen%s" voor een lijst van ondersteunde landen

Field: country_of_origin_map_url
  Type: String
  Description: Een link naar een kaart die het resultaat in een weergegeven vorm laat zien. De kaart kan gedurende 10 minuten worden bekeken.
Bijvoorbeeld, je kunt deze kaart insluiten in je product door een iframe te gebruiken.

Field: duration
  Type: String
  Description: Tijd die de server nodig had om het verzoek te verwerken

Field: credits_used
  Type: Integer
  Description: Het aantal verzoeken dat voor deze query is gebruikt

--- IMPLEMENTATION NOTES ---

1. Make sure to replace placeholder values:
   - Replace '' with your actual API key
   - Replace domain placeholders with the actual API domain

2. Handle errors appropriately:
   - Check HTTP status codes
   - Parse error responses
   - Implement retry logic for transient failures

3. Best Practices:
   - Store API keys securely (use environment variables)
   - Implement rate limiting on your side
   - Cache responses when appropriate
   - Use HTTPS for all requests
   - Set appropriate timeout values

4. RECOMMENDED: Implement the Statistics Endpoint
   - The statistics endpoint allows users to monitor their credit usage
   - Users can see how many credits they have used and how many are left
   - This helps prevent unexpected service interruptions
   - API v1: GET /get-stats?key=YOUR_API_KEY
   - API v2: GET /v2/statistic (with Authorization Bearer token)
   - Display remaining credits in your application's UI
   - Consider adding alerts when credits are running low

--- IMPLEMENTATION TEMPLATE ---

// Example implementation in cURL:
curl -X GET \
  'https://gender-api.com/get-country-of-origin?name=Markus&key=YOUR_API_KEY' \

--- CREDIT USAGE ---
Required Requests: 2

=== END OF INSTRUCTIONS ===