API & Integrations

API Overview

System Status

API Overview SDKs Webhooks Data Ownership

API Overview

Request routes — or request deliveries — programmatically using the Yspace API.

Route Intelligence

Routing, ETA prediction and logistics intelligence for your own fleet.

Delivery API

Yspace physically delivers a package for you. This powers the Marketplace use case.

Product API

Route Intelligence

Send an origin, destination, stops and vehicle profile to get route recommendations, distance, duration, ETA, alternatives and confidence.

Sample request

curl -X POST https://api.yspace.live/v1/routes \
  -H "Authorization: Bearer $YSPACE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "origin": "Ikoyi Depot",
    "destination": "Lekki Phase 1 Hub",
    "stops": ["Victoria Island Yard"],
    "vehicle_profile": "van_urban"
  }'

Sample response

Example request: Origin, Destination, Stops and Vehicle Profile. The response below shows the route data shape.

{
  "route_id": "rt_example_01",
  "recommended_route": {
    "summary": "Ikoyi Depot → Lekki Phase 1 Hub via Victoria Island Yard",
    "vehicle_profile": "van_urban"
  },
  "distance": {
    "value": 18.2,
    "unit": "km"
  },
  "duration": {
    "value": 2460,
    "unit": "seconds"
  },
  "eta": "2026-10-01T09:41:00Z",
  "alternatives": [
    {
      "summary": "via Third Mainland Bridge",
      "distance": 21.6,
      "duration": 2880
    }
  ],
  "confidence": 0.91
}

Product API

Delivery API

Request a delivery option from pickup and dropoff locations plus package details; Yspace handles physical fulfilment.

Sample request

curl -X POST https://api.yspace.live/v1/deliveries/quote \
  -H "Authorization: Bearer $YSPACE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "pickup_location": "Ikoyi Depot",
    "dropoff_location": "Lekki Phase 1 Hub",
    "package_weight": { "value": 2.4, "unit": "kg" },
    "package_dimensions": { "length": 30, "width": 20, "height": 12, "unit": "cm" }
  }'

Sample response

Example request: pickup_location, dropoff_location, package_weight and package_dimensions.

{
  "delivery_option": {
    "id": "delopt_example_01",
    "service": "Yspace Standard"
  },
  "estimated_delivery_time": "2026-10-01T13:30:00Z",
  "delivery_price": 4500,
  "currency": "NGN"
}

These examples are for reference and use placeholder credentials. They do not send a live request or require an account.