Saisie semi-automatique

Des suggestions pendant la saisie, facturées par session.

Remarque :

Envoyez votre clé avec key=VOTRE_CLE_API dans l’adresse, ou dans l’en-tête X-NWays-Api-Key. Clés d’API

Adresse de base : https://nways.ng/maps/v1

Suggestions pendant la saisie (facturées par session)

GET https://nways.ng/maps/v1/autocomplete

Envoyez le même jeton session (8 à 64 caractères parmi A–Z a–z 0–9 - _, un UUID convient) dès la première lettre jusqu’à ce que l’utilisateur choisisse un résultat : la première requête de la session est facturée (une session autocomplete) ; les suivantes comptent pour la limite de débit mais ne sont pas facturées, tant qu’il n’y a pas plus de 3 minutes entre deux requêtes, dans la limite de 15 minutes et 100 requêtes au total. Prenez un nouveau jeton après un choix. Sans jeton, chaque requête est une session. X-NWays-Session-Billed: 1|0 indique lequel des deux cas s’applique. Raisons : comme /geocode, plus SESSION_INVALID, TYPES_INVALID.

Paramètres

Nom	Où	Type	Description
`q`	requête	`string`	Obligatoire.
`session`	requête	`string`
`near`	requête	`string`	lat,lng : classer et choisir les résultats proches de ce point.
`country`	requête	`string`	Liste séparée par des virgules parmi NG, GH, BJ, TG, GA, CI, LR, GN, SL, GW, SN, CM, BF, CV, GM.
`types`	requête	`string`	Liste séparée par des virgules parmi address, street, business, place, area, postcode, ghanapost.
`limit`	requête	`integer`	Par défaut: `5`. ≥ 1, ≤ 10.
`lang`	requête	`string`	Au choix: `en`, `fr`, `pt`. Par défaut: `en`.
`fields`	requête	`string`	Liste séparée par des virgules des champs à garder dans chaque résultat (`a.b` descend dans les objets ; `id` est toujours gardé ; `*` = tous).

cURL

curl "https://nways.ng/maps/v1/autocomplete?q=lekki+ph" \
  -H "X-NWays-Api-Key: VOTRE_CLE_API"

JavaScript

const res = await fetch('https://nways.ng/maps/v1/autocomplete?q=lekki+ph', {
  headers: { 'X-NWays-Api-Key': process.env.NWAYS_API_KEY },
})
const data = await res.json()

Python

import os
import requests

res = requests.get(
    "https://nways.ng/maps/v1/autocomplete?q=lekki+ph",
    headers={"X-NWays-Api-Key": os.environ["NWAYS_API_KEY"]},
    timeout=10,
)
data = res.json()

Réponse

Suggestions

Champ	Type	Description
`results`	`Result[]`	Obligatoire.
`results[].id`	`string`	Obligatoire.
`results[].name`	`string`	Obligatoire.
`results[].type`	`string`	Obligatoire. address, street, business, landmark, building, postcode, ghanapost, ou une zone : neighbourhood, suburb, village, town, city, state…
`results[].category`	`string`
`results[].location`	`Point`	Obligatoire.
`results[].location.type`	`string`	Obligatoire.
`results[].location.coordinates`	`number[]`	Obligatoire. [lng, lat] Au moins 2 éléments, au plus 2 éléments.
`results[].bbox`	`number[]`	ouest, sud, est, nord (zones) Au moins 4 éléments, au plus 4 éléments.
`results[].formattedAddress`	`string`
`results[].postcode`	`string`	Code postal NIPOST, forme compacte
`results[].ghanaPost`	`string`
`results[].plusCode`	`string`	Obligatoire.
`results[].country`	`string`
`results[].distanceM`	`number`	Depuis near (ou le point demandé).
`results[].estimated`	`boolean`	Le point est une estimation, à accuracyM près.
`results[].accuracyM`	`number`
`results[].placeId`	`string`	Un commerce : son id pour /places/{id}.
`results[].attribution`	`string`
`didYouMean`	`string`
`attribution`	`string`	Obligatoire.

200 OK

{
  "results": [
    {
      "id": "osm:w568367632",
      "name": "Ikeja City Mall",
      "type": "landmark",
      "category": "shopping",
      "location": {
        "type": "string",
        "coordinates": [
          0
        ]
      },
      "bbox": [
        0
      ],
      "formattedAddress": "Ikeja, Lagos",
      "postcode": "LA08A09DB09",
      "ghanaPost": "GA-183-8164",
      "plusCode": "6FR5J975+P4W",
      "country": "NG",
      "distanceM": 0,
      "estimated": true,
      "accuracyM": 0,
      "placeId": "string",
      "attribution": "string"
    }
  ],
  "didYouMean": "string",
  "attribution": "string"
}

Erreurs

default Erreur