Lugares

Negócios e lugares perto de um ponto, por texto, e os detalhes de um lugar.

Nesta página

Negócios e locais perto de um ponto
Negócios e locais por texto
Detalhes de um local

Nota:

Envie a sua chave com key=A_SUA_CHAVE_API no endereço, ou no cabeçalho X-NWays-Api-Key. Chaves de API

Endereço base: https://nways.ng/maps/v1

Negócios e locais perto de um ponto

GET https://nways.ng/maps/v1/places/nearby

Por categoria (ordenados por proximidade e relevância, 40 por página; as listas de ATM e dinheiro põem primeiro as máquinas que pagam) e/ou nome. fields= define o SKU: campos básicos (por omissão) search; qualquer campo de contacto places_contact; qualquer campo de ambiente places_atmosphere. Motivos: LAT_LNG_REQUIRED, CATEGORY_INVALID, CATEGORY_OR_QUERY_REQUIRED, RADIUS_INVALID, PAGE_TOKEN_INVALID, FIELDS_INVALID.

Parâmetros

Nome	Onde	Tipo	Descrição
`lat`	consulta	`number`	Obrigatório.
`lng`	consulta	`number`	Obrigatório.
`category`	consulta	`string`	Um de: `petrol`, `charging`, `food`, `fastfood`, `cafe`, `bar`, `pos`, `bank`, `atm`, `cash`, `mechanic`, `vulcanizer`, `carwash`, `police`, `hospital`, `pharmacy`, `hotel`, `supermarket`, `shop`, `market`, `motorpark`, `parking`, `church`, `mosque`, `phones`, `salon`, `school`, `office`, `attraction`, `estate`, `residential`, `government`, `university`.
`q`	consulta	`string`	Até 60 caracteres.
`radius`	consulta	`number`	≥ 200, ≤ 50000.
`limit`	consulta	`integer`	Predefinição: `40`. ≥ 1, ≤ 40.
`pageToken`	consulta	`string`
`fields`	consulta	`string`	Básico (SKU search): id, name, category, location, formattedAddress, plusCode, country, distanceM, businessStatus, attribution. Contacto (places_contact): phone, email, website, openingHours. Ambiente (places_atmosphere): rating, amenities, details. Por omissão: básico.

cURL

curl "https://nways.ng/maps/v1/places/nearby?lat=6.4474&lng=3.472" \
  -H "X-NWays-Api-Key: A_SUA_CHAVE_API"

JavaScript

const res = await fetch('https://nways.ng/maps/v1/places/nearby?lat=6.4474&lng=3.472', {
  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/places/nearby?lat=6.4474&lng=3.472",
    headers={"X-NWays-Api-Key": os.environ["NWAYS_API_KEY"]},
    timeout=10,
)
data = res.json()

Resposta

Locais

Campo	Tipo	Descrição
`places`	`Place[]`	Obrigatório.
`places[].id`	`string`	Obrigatório.
`places[].name`	`string`
`places[].category`	`string`
`places[].location`	`Point`
`places[].location.type`	`string`	Obrigatório.
`places[].location.coordinates`	`number[]`	Obrigatório. [lng, lat] Pelo menos 2 elementos, no máximo 2 elementos.
`places[].formattedAddress`	`string`
`places[].plusCode`	`string`
`places[].country`	`string`
`places[].distanceM`	`number`
`places[].businessStatus`	`string`	Um de: `OPERATIONAL`, `UNVERIFIED`, `REPORTED_CLOSED`.
`places[].attribution`	`string`
`places[].phone`	`string`	Nível contacto
`places[].email`	`string`	Nível contacto
`places[].website`	`string`	Nível contacto
`places[].openingHours`	`object`	Nível contacto
`places[].openingHours.text`	`string`	Obrigatório. Sintaxe opening_hours do OpenStreetMap
`places[].openingHours.source`	`string`	Obrigatório. Um de: `listed`, `owner`, `brand`, `usual`.
`places[].openingHours.confirmed`	`integer`
`places[].rating`	`object`	Nível ambiente
`places[].rating.score`	`number`	1–5, suavizado
`places[].rating.count`	`integer`
`places[].rating.percentUp`	`integer`
`places[].rating.reviewCount`	`integer`
`places[].amenities`	`object`	Nível ambiente: o que oferece, como etiquetas OpenStreetMap (payment:*, wheelchair, delivery…).
`places[].details`	`object`	Nível ambiente: detalhes por setor de atividade.
`nextPageToken`	`string`
`attribution`	`string`	Obrigatório.

200 OK

{
  "places": [
    {
      "id": "osm:n2987189855",
      "name": "Shoprite",
      "category": "supermarket",
      "location": {
        "type": "string",
        "coordinates": [
          0
        ]
      },
      "formattedAddress": "string",
      "plusCode": "string",
      "country": "string",
      "distanceM": 0,
      "businessStatus": "OPERATIONAL",
      "attribution": "string",
      "phone": "string",
      "email": "string",
      "website": "string",
      "openingHours": {
        "text": "Mo-Su 09:00-21:00",
        "source": "listed",
        "confirmed": 0
      },
      "rating": {
        "score": 0,
        "count": 0,
        "percentUp": 0,
        "reviewCount": 0
      },
      "amenities": {},
      "details": {}
    }
  ],
  "nextPageToken": "string",
  "attribution": "string"
}

Erros

default Erro

Negócios e locais por texto

GET https://nways.ng/maps/v1/places/search

"Zenith Bank Ikeja", "farmácia perto de Yaba". SKU como em /places/nearby. Motivos: os de /geocode, e RADIUS_INVALID, FIELDS_INVALID.

Parâmetros

Nome	Onde	Tipo	Descrição
`q`	consulta	`string`	Obrigatório.
`near`	consulta	`string`	lat,lng: ordenar e escolher resultados perto deste ponto.
`radius`	consulta	`number`	Com near. ≥ 200, ≤ 50000.
`country`	consulta	`string`	Lista separada por vírgulas de NG, GH, BJ, TG, GA, CI, LR, GN, SL, GW, SN, CM, BF, CV, GM.
`limit`	consulta	`integer`	Predefinição: `10`. ≥ 1, ≤ 20.
`lang`	consulta	`string`	Um de: `en`, `fr`, `pt`. Predefinição: `en`.
`fields`	consulta	`string`	Básico (SKU search): id, name, category, location, formattedAddress, plusCode, country, distanceM, businessStatus, attribution. Contacto (places_contact): phone, email, website, openingHours. Ambiente (places_atmosphere): rating, amenities, details. Por omissão: básico.

cURL

curl "https://nways.ng/maps/v1/places/search?q=pharmacy+Yaba" \
  -H "X-NWays-Api-Key: A_SUA_CHAVE_API"

JavaScript

const res = await fetch('https://nways.ng/maps/v1/places/search?q=pharmacy+Yaba', {
  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/places/search?q=pharmacy+Yaba",
    headers={"X-NWays-Api-Key": os.environ["NWAYS_API_KEY"]},
    timeout=10,
)
data = res.json()

Resposta

Locais

Campo	Tipo	Descrição
`places`	`Place[]`	Obrigatório.
`places[].id`	`string`	Obrigatório.
`places[].name`	`string`
`places[].category`	`string`
`places[].location`	`Point`
`places[].location.type`	`string`	Obrigatório.
`places[].location.coordinates`	`number[]`	Obrigatório. [lng, lat] Pelo menos 2 elementos, no máximo 2 elementos.
`places[].formattedAddress`	`string`
`places[].plusCode`	`string`
`places[].country`	`string`
`places[].distanceM`	`number`
`places[].businessStatus`	`string`	Um de: `OPERATIONAL`, `UNVERIFIED`, `REPORTED_CLOSED`.
`places[].attribution`	`string`
`places[].phone`	`string`	Nível contacto
`places[].email`	`string`	Nível contacto
`places[].website`	`string`	Nível contacto
`places[].openingHours`	`object`	Nível contacto
`places[].openingHours.text`	`string`	Obrigatório. Sintaxe opening_hours do OpenStreetMap
`places[].openingHours.source`	`string`	Obrigatório. Um de: `listed`, `owner`, `brand`, `usual`.
`places[].openingHours.confirmed`	`integer`
`places[].rating`	`object`	Nível ambiente
`places[].rating.score`	`number`	1–5, suavizado
`places[].rating.count`	`integer`
`places[].rating.percentUp`	`integer`
`places[].rating.reviewCount`	`integer`
`places[].amenities`	`object`	Nível ambiente: o que oferece, como etiquetas OpenStreetMap (payment:*, wheelchair, delivery…).
`places[].details`	`object`	Nível ambiente: detalhes por setor de atividade.
`nextPageToken`	`string`
`attribution`	`string`	Obrigatório.

200 OK

{
  "places": [
    {
      "id": "osm:n2987189855",
      "name": "Shoprite",
      "category": "supermarket",
      "location": {
        "type": "string",
        "coordinates": [
          0
        ]
      },
      "formattedAddress": "string",
      "plusCode": "string",
      "country": "string",
      "distanceM": 0,
      "businessStatus": "OPERATIONAL",
      "attribution": "string",
      "phone": "string",
      "email": "string",
      "website": "string",
      "openingHours": {
        "text": "Mo-Su 09:00-21:00",
        "source": "listed",
        "confirmed": 0
      },
      "rating": {
        "score": 0,
        "count": 0,
        "percentUp": 0,
        "reviewCount": 0
      },
      "amenities": {},
      "details": {}
    }
  ],
  "nextPageToken": "string",
  "attribution": "string"
}

Erros

default Erro

Detalhes de um local

GET https://nways.ng/maps/v1/places/{id}

fields é obrigatório: os campos de que precisa (definem o SKU), ou * para todos (places_atmosphere). Motivos: PLACE_ID_INVALID, FIELDS_REQUIRED, FIELDS_INVALID, PLACE_NOT_FOUND.

Parâmetros

Nome	Onde	Tipo	Descrição
`id`	caminho	`string`	Obrigatório.
`fields`	consulta	`string`	Obrigatório.

cURL

curl "https://nways.ng/maps/v1/places/osm%3An2987189855?fields=name%2Clocation%2Cphone%2CopeningHours" \
  -H "X-NWays-Api-Key: A_SUA_CHAVE_API"

JavaScript

const res = await fetch('https://nways.ng/maps/v1/places/osm%3An2987189855?fields=name%2Clocation%2Cphone%2CopeningHours', {
  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/places/osm%3An2987189855?fields=name%2Clocation%2Cphone%2CopeningHours",
    headers={"X-NWays-Api-Key": os.environ["NWAYS_API_KEY"]},
    timeout=10,
)
data = res.json()

Resposta

O local

Campo	Tipo	Descrição
`id`	`string`	Obrigatório.
`name`	`string`
`category`	`string`
`location`	`Point`
`location.type`	`string`	Obrigatório.
`location.coordinates`	`number[]`	Obrigatório. [lng, lat] Pelo menos 2 elementos, no máximo 2 elementos.
`formattedAddress`	`string`
`plusCode`	`string`
`country`	`string`
`distanceM`	`number`
`businessStatus`	`string`	Um de: `OPERATIONAL`, `UNVERIFIED`, `REPORTED_CLOSED`.
`attribution`	`string`
`phone`	`string`	Nível contacto
`email`	`string`	Nível contacto
`website`	`string`	Nível contacto
`openingHours`	`object`	Nível contacto
`openingHours.text`	`string`	Obrigatório. Sintaxe opening_hours do OpenStreetMap
`openingHours.source`	`string`	Obrigatório. Um de: `listed`, `owner`, `brand`, `usual`.
`openingHours.confirmed`	`integer`
`rating`	`object`	Nível ambiente
`rating.score`	`number`	1–5, suavizado
`rating.count`	`integer`
`rating.percentUp`	`integer`
`rating.reviewCount`	`integer`
`amenities`	`object`	Nível ambiente: o que oferece, como etiquetas OpenStreetMap (payment:*, wheelchair, delivery…).
`details`	`object`	Nível ambiente: detalhes por setor de atividade.

200 OK

{
  "id": "osm:n2987189855",
  "name": "Shoprite",
  "category": "supermarket",
  "location": {
    "type": "string",
    "coordinates": [
      0
    ]
  },
  "formattedAddress": "string",
  "plusCode": "string",
  "country": "string",
  "distanceM": 0,
  "businessStatus": "OPERATIONAL",
  "attribution": "string",
  "phone": "string",
  "email": "string",
  "website": "string",
  "openingHours": {
    "text": "Mo-Su 09:00-21:00",
    "source": "listed",
    "confirmed": 0
  },
  "rating": {
    "score": 0,
    "count": 0,
    "percentUp": 0,
    "reviewCount": 0
  },
  "amenities": {},
  "details": {}
}

Erros

default Erro