@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
@optional {ip: str, localityLanguage: str, key: str}
@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
@optional {ip: str, localityLanguage: str, key: str}
@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
@optional {ip: str, localityLanguage: str, key: str}
@returns(200) {ip: str, localityLanguageRequested: str, isReachableGlobally: bool, country: map, location: map, lastUpdated: str, network: map, confidence: str, confidenceArea: [map]}

@end