{"openapi":"3.2.0","info":{"title":"Bulk Geocoding (France) API","description":"Géocoder en Masse des adresses en France. Bulk Geocoding (France). Jusqu'à 1000 adresses à chaque requête. Fast and cost optimized Bulk French Address Geocoder using public API of BAN (Base Adresse Nationale), recently transferred to IGN (Institut National de l’Information Géographique et Forestière). The API allows you to query the two databases: BAN and BD TOPO.","version":"1.0.0"},"servers":[{"url":"https://aerjy.jojapi.net"}],"security":[{"ApiKeyAuth":[]}],"x-agent-commerce":{"catalog_url":"https://aerjy.jojapi.net/_jojapi/agent/plans","discovery_url":"https://aerjy.jojapi.net/.well-known/x402","directory_url":"https://agents.jojapi.net/apis/bulk-geocoding-france","docs":"https://docs.jojapi.com/consumers/agents"},"paths":{"/geocode":{"post":{"operationId":"post_geocode","summary":"geocode","description":"Geo-code a list of addresses: convert a list of adresses in France into GPS coordinates (latitude, longitude).","responses":{"200":{"description":"Response 200","content":{"application/json":{"example":[{"input_id":0,"input_adr":"16 Rue de avoie, 93330 Neuilly-sur-Marne","longitude":2.531402,"latitude":48.86863,"label":"Rue de Savoie 93330 Neuilly-sur-Marne","type_adr":"street","street":"Rue de Savoie","postcode":93330,"city":"Neuilly-sur-Marne","citycode":93050,"context":"93, Seine-Saint-Denis, Île-de-France","score":0.82,"source":"address","status":"ok"}]}}},"402":{"description":"Payment required — pay per request with x402/mpp (offer in the PAYMENT-REQUIRED / WWW-Authenticate headers and the JSON body), or send a JoJ API key."}},"x-payment-info":{"protocols":["x402","mpp"],"price":{"mode":"fixed","currency":"USD","amount":"0.01"},"intent":"charge"},"parameters":[{"name":"addresses","in":"query","description":"A list of postal addresses located in France to geocode","required":true,"schema":{"type":"array","items":{"type":"string"},"title":"Addresses to geocode","example":["16 Rue de avoie, 93330 Neuilly-sur-Marne"]}},{"name":"bulk_mode","in":"query","description":"In bulk mode, input addresses are processed in batches, which reduces the number of calls to the geocoder API. In this mode, only one candidate is collected for each address. If bulk mode is disabled, each input address generates a call to the API.","required":false,"schema":{"type":"boolean","title":"Enable Bulk mode","example":true,"default":true}},{"name":"index","in":"query","description":"Select Search Index: 'address' is the postal addresses index, 'poi' is the 'places' index (administrative buildings, schools, museums, etc)","required":false,"schema":{"type":"string","enum":["address","poi"],"title":"Select Search Index","example":"address","default":"address"}},{"name":"max_candidates","in":"query","description":"Maximum matching candidates for each input address. A matching score is assigned to each candidate. This parameter is ignored if bulk mode is set to 'true'","required":false,"schema":{"type":"integer","title":"Maximum maching candidates for each address","example":5,"default":5}},{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string","example":"application/json","default":"application/json"}}],"requestBody":{"content":{"application/json":{"schema":{"externalDocs":{"url":"http://82.223.139.194/ign/docs"}},"example":{"addresses":["16 Rue de avoie, 93330 Neuilly-sur-Marne"],"bulk_mode":true,"index":"address","max_candidates":5}}}}}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"X-JoJAPI-Key","description":"Your JoJ API key."}}}}