Zones

On this page

The project's zones (circles), each with how many vehicles are in it now
Add a zone (at most 200 a project)
Get a zone
Rename, move or resize a zone (lat and lng together)
Delete a zone

Note:

Send your key as key=YOUR_API_KEY on the address, or in the X-NWays-Api-Key header. API keys

Base address: https://nways.ng/maps/v1/fleet

The project's zones (circles), each with how many vehicles are in it now

GET https://nways.ng/maps/v1/fleet/zones

cURL

curl "https://nways.ng/maps/v1/fleet/zones" \
  -H "X-NWays-Api-Key: YOUR_API_KEY"

JavaScript

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

Response

Zones

Field	Type	Description
`zones`	`Zone[]`	Required.
`zones[].id`	`string`	Required.
`zones[].name`	`string`	Required.
`zones[].lat`	`number`	Required.
`zones[].lng`	`number`	Required.
`zones[].radiusM`	`integer`	Required.
`zones[].vehicles`	`integer`	Required. Vehicles inside now.
`zones[].createdAt`	`string (date-time)`	Required.
`zones[].updatedAt`	`string (date-time)`	Required.

200 OK

{
  "zones": [
    {
      "id": "string",
      "name": "string",
      "lat": 0,
      "lng": 0,
      "radiusM": 0,
      "vehicles": 0,
      "createdAt": "2026-10-15T09:00:00+01:00",
      "updatedAt": "2026-10-15T09:00:00+01:00"
    }
  ]
}

Errors

default Error

Add a zone (at most 200 a project)

POST https://nways.ng/maps/v1/fleet/zones

Vehicles entering and leaving it send zone.entered and zone.exited, from each vehicle's newest position.

Request body

Field	Type	Description
`id`	`string`
`name`	`string`	Up to 100 characters.
`lat`	`number`	Required.
`lng`	`number`	Required.
`radiusM`	`integer`	Required. ≥ 50, ≤ 50000.

cURL

curl -X POST "https://nways.ng/maps/v1/fleet/zones" \
  -H "X-NWays-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"id":"depot-yaba","name":"Yaba depot","lat":6.5095,"lng":3.3711,"radiusM":300}'

JavaScript

const res = await fetch('https://nways.ng/maps/v1/fleet/zones', {
  method: 'POST',
  headers: { 'X-NWays-Api-Key': process.env.NWAYS_API_KEY, 'Content-Type': 'application/json' },
  body: JSON.stringify({
    "id": "depot-yaba",
    "name": "Yaba depot",
    "lat": 6.5095,
    "lng": 3.3711,
    "radiusM": 300
  }),
})
const data = await res.json()

Python

import os
import requests

res = requests.post(
    "https://nways.ng/maps/v1/fleet/zones",
    headers={"X-NWays-Api-Key": os.environ["NWAYS_API_KEY"]},
    json={"id": "depot-yaba", "name": "Yaba depot", "lat": 6.5095, "lng": 3.3711, "radiusM": 300},
    timeout=10,
)
data = res.json()

Response

Created

Field	Type	Description
`id`	`string`	Required.
`name`	`string`	Required.
`lat`	`number`	Required.
`lng`	`number`	Required.
`radiusM`	`integer`	Required.
`vehicles`	`integer`	Required. Vehicles inside now.
`createdAt`	`string (date-time)`	Required.
`updatedAt`	`string (date-time)`	Required.

201 OK

{
  "id": "string",
  "name": "string",
  "lat": 0,
  "lng": 0,
  "radiusM": 0,
  "vehicles": 0,
  "createdAt": "2026-10-15T09:00:00+01:00",
  "updatedAt": "2026-10-15T09:00:00+01:00"
}

Errors

default Error

Get a zone

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

Parameters

Name	In	Type	Description
`id`	path	`string`	Required.

cURL

curl "https://nways.ng/maps/v1/fleet/zones/string" \
  -H "X-NWays-Api-Key: YOUR_API_KEY"

JavaScript

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

Response

Zone

Field	Type	Description
`id`	`string`	Required.
`name`	`string`	Required.
`lat`	`number`	Required.
`lng`	`number`	Required.
`radiusM`	`integer`	Required.
`vehicles`	`integer`	Required. Vehicles inside now.
`createdAt`	`string (date-time)`	Required.
`updatedAt`	`string (date-time)`	Required.

200 OK

{
  "id": "string",
  "name": "string",
  "lat": 0,
  "lng": 0,
  "radiusM": 0,
  "vehicles": 0,
  "createdAt": "2026-10-15T09:00:00+01:00",
  "updatedAt": "2026-10-15T09:00:00+01:00"
}

Errors

default Error

Rename, move or resize a zone (lat and lng together)

PATCH https://nways.ng/maps/v1/fleet/zones/{id}

Parameters

Name	In	Type	Description
`id`	path	`string`	Required.

Request body

Field	Type	Description
`name`	`string`	Up to 100 characters.
`lat`	`number`
`lng`	`number`
`radiusM`	`integer`	≥ 50, ≤ 50000.

cURL

curl -X PATCH "https://nways.ng/maps/v1/fleet/zones/string" \
  -H "X-NWays-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","lat":0,"lng":0,"radiusM":0}'

JavaScript

const res = await fetch('https://nways.ng/maps/v1/fleet/zones/string', {
  method: 'PATCH',
  headers: { 'X-NWays-Api-Key': process.env.NWAYS_API_KEY, 'Content-Type': 'application/json' },
  body: JSON.stringify({
    "name": "string",
    "lat": 0,
    "lng": 0,
    "radiusM": 0
  }),
})
const data = await res.json()

Python

import os
import requests

res = requests.patch(
    "https://nways.ng/maps/v1/fleet/zones/string",
    headers={"X-NWays-Api-Key": os.environ["NWAYS_API_KEY"]},
    json={"name": "string", "lat": 0, "lng": 0, "radiusM": 0},
    timeout=10,
)
data = res.json()

Response

Zone

Field	Type	Description
`id`	`string`	Required.
`name`	`string`	Required.
`lat`	`number`	Required.
`lng`	`number`	Required.
`radiusM`	`integer`	Required.
`vehicles`	`integer`	Required. Vehicles inside now.
`createdAt`	`string (date-time)`	Required.
`updatedAt`	`string (date-time)`	Required.

200 OK

{
  "id": "string",
  "name": "string",
  "lat": 0,
  "lng": 0,
  "radiusM": 0,
  "vehicles": 0,
  "createdAt": "2026-10-15T09:00:00+01:00",
  "updatedAt": "2026-10-15T09:00:00+01:00"
}

Errors

default Error

Delete a zone

DELETE https://nways.ng/maps/v1/fleet/zones/{id}

Parameters

Name	In	Type	Description
`id`	path	`string`	Required.

cURL

curl -X DELETE "https://nways.ng/maps/v1/fleet/zones/string" \
  -H "X-NWays-Api-Key: YOUR_API_KEY"

JavaScript

const res = await fetch('https://nways.ng/maps/v1/fleet/zones/string', {
  method: 'DELETE',
  headers: { 'X-NWays-Api-Key': process.env.NWAYS_API_KEY },
})
const data = await res.json()

Python

import os
import requests

res = requests.delete(
    "https://nways.ng/maps/v1/fleet/zones/string",
    headers={"X-NWays-Api-Key": os.environ["NWAYS_API_KEY"]},
    timeout=10,
)
data = res.json()

Response

Deleted

No content.

Errors

default Error