Skip to content

API Reference: Real-Time Mobility Platform ​

Base URL: http://localhost:4000 ​

Rider & Captain Auth Endpoints ​

MethodEndpointAuthPurposeStatus Codes
POST/users/registerNoRegister new rider account201, 400
POST/users/loginNoAuthenticate rider & issue JWT200, 401
GET/users/profileBearerGet authenticated rider profile200, 401
GET/users/logoutBearerRevoke token and logout rider200
POST/captains/registerNoRegister new commercial driver201, 400
POST/captains/loginNoAuthenticate captain & issue JWT200, 401
GET/captains/profileBearerGet authenticated captain profile200, 401
GET/captains/logoutBearerRevoke token and logout captain200

Maps & Geospatial Endpoints ​

MethodEndpointAuthPurposeStatus Codes
GET/maps/get-coordinatesBearerGeocode text address into lat/lng200, 404
GET/maps/get-distance-timeBearerQuery distance and duration between points200, 400
GET/maps/get-suggestionsBearerAddress search autocomplete200, 500

Ride Management Endpoints ​

MethodEndpointAuthPurposeStatus Codes
POST/rides/createRiderCreate ride request and generate OTP201, 400
GET/rides/get-fareRiderQuote fare across Car, Moto, and Auto200, 400
POST/rides/confirmCaptainCaptain accepts pending ride200, 400
GET/rides/start-rideCaptainValidate OTP and initiate transit200, 400
POST/rides/end-rideCaptainMark ride completed at destination200, 400