@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api IP Geolocation API
@base https://api-bdc.net/data/ip-geolocation
@auth ApiKey key in query
@endpoints 3
@toc data(3)

@endpoint GET /data/ip-geolocation
@desc This API returns additional security hazard report in addition to confidence area and locality information
@optional {ip: str # IPv4 IP address in a string or numeric format. If omitted, the caller’s IP address is assumed, localityLanguage: str # Preferred language for locality names in ISO 639-1 format, such as 'en' for English, 'es' for Spanish etc. Please note: 147 common world languages are supported, full list here, but not all languages are available for every location. If requested language is not available for a requested location it will default to English, if no English is available, the native, local names will be provided, key: str # Your API key}
@returns(200) {ip: str, localityLanguageRequested: str, isReachableGlobally: bool, country: map, location: map, lastUpdated: str, network: map, confidence: str, confidenceArea: [map], securityThreat: str, hazardReport: map}

@endpoint GET /data/ip-geolocation-with-confidence
@desc Returns list of geocoordinates which represents estimated geolocation confidence area
@optional {ip: str # IPv4 IP address in a string or numeric format. If omitted, the caller’s IP address is assumed, localityLanguage: str # Preferred language for locality names in ISO 639-1 format, such as 'en' for English, 'es' for Spanish etc. Please note: 147 common world languages are supported, full list here, but not all languages are available for every location. If requested language is not available for a requested location it will default to English, if no English is available, the native, local names will be provided, key: str # Your API key}
@returns(200) {ip: str, localityLanguageRequested: str, isReachableGlobally: bool, country: map, location: map, lastUpdated: str, network: map, confidence: str, confidenceArea: [map]}

@endpoint GET /data/ip-geolocation-full
@desc Returns list of geocoordinates which represents estimated geolocation confidence area
@optional {ip: str # IPv4 IP address in a string or numeric format. If omitted, the caller’s IP address is assumed, localityLanguage: str # Preferred language for locality names in ISO 639-1 format, such as 'en' for English, 'es' for Spanish etc. Please note: 147 common world languages are supported, full list here, but not all languages are available for every location. If requested language is not available for a requested location it will default to English, if no English is available, the native, local names will be provided, key: str # Your API key}
@returns(200) {ip: str, localityLanguageRequested: str, isReachableGlobally: bool, country: map, location: map, lastUpdated: str, network: map, confidence: str, confidenceArea: [map]}

@end