Guide

Getting Started

Make your first call to the ORN API: get access, create an application and credential, and read a journey record over HTTPS.

What the ORN API is

The ORN API is the same structured journey infrastructure that powers the Orange Rides Network platform — journeys, checkpoints, safety signals, route context, ORION analysis and passenger insight — served over HTTPS as JSON. Nothing is re-modelled for the API: your software reads and writes the same records the network runs on.

61 priced operations across six capabilities: Journeys, Checkpoints, Safety, Route Intelligence, Orion Intelligence and Passenger Intelligence.
A seventh capability, Notifications (event delivery), is registered — its priced operations are planned and will be announced in the changelog.
Bearer-keyed authentication with application-level scopes.
Every call is metered, priced in naira and recorded — see Usage and Pricing.

Base URL

https://www.orangeridesnetwork.org/api/v1

All operation paths in this documentation are relative to this base.

Responses are JSON. Every response — success or error — carries an x-request-id header that correlates the call with your usage records and ORN support.

Get access

1. Join the network as a ride owner — register, get verified with the ORN team and choose a subscription during onboarding.
2. Open the Developer Console in your dashboard (Developer → API).
3. Create an application. Applications carry your granted scopes and an environment (sandbox or production).
4. Create a credential. The raw API key is shown exactly once — store it somewhere safe. Keys look like orn_live_… (production) or orn_test_… (sandbox).
5. Fund your API wallet (see Wallet). The first 10 calls per capability are free.

API access is granted to verified ride-owner organizations. If the Developer Console is not visible on your dashboard, contact the support desk to have API access enabled for your organization.

Make your first request

Read one of your journey records by id. Replace the bearer key and journey id with your own values.

curl "https://www.orangeridesnetwork.org/api/v1/journeys/get_journey?journey_id=YOUR_JOURNEY_ID" \
  -H "Authorization: Bearer orn_live_YOUR_KEY"

Requires the journeys:read scope. The response shape is illustrated below.

{
  "data": {
    "journey_id": "0d0b6f2e-6b1a-4f3e-9a4c-1f2e3d4c5b6a",
    "reference": "JRN-4F7K2Q",
    "route_id": "3c2b1a0f-9e8d-4c7b-a6f5-e4d3c2b1a0f9",
    "state": "draft",
    "departure_datetime": "2026-09-28T08:30:00.000Z",
    "estimated_arrival_datetime": "2026-09-28T10:45:00.000Z",
    "available_seats": 3,
    "fare_amount": 4500,
    "currency": "NGN",
    "driver_name": "Adaeze Okafor",
    "driver_phone": "+2348030000000",
    "vehicle_type": "bus",
    "vehicle_colour": "White",
    "created_at": "2026-09-26T09:12:44.120Z",
    "updated_at": "2026-09-26T09:12:44.120Z"
  }
}

Illustrative shape — the same field-for-field payload shown in the operation reference above.

Where to go next

Authentication — how keys, environments and scopes work.
API Operations — every capability and operation, with parameters, errors and traceability.
Pricing and Wallet — how calls are metered and charged.
Errors — the error taxonomy and how to correlate with x-request-id.