GEThttps://mqtt-data-pipeline.taxieco-software.com/
Health check endpoint

Params

GEThttps://mqtt-data-pipeline.taxieco-software.com/find-my-car
Find a car by license plate

Params

fromstring (required) - YYYY-MM-DD HH:MM:SS
tostring (required) - YYYY-MM-DD HH:MM:SS
contentstring (required)

Sample Request

https://mqtt-data-pipeline.taxieco-software.com/find-my-car?from=2024-03-01 00:00:00&to=2025-04-01 00:00:00&content=a

Sample Response

[
    {
        "row_id": 2499308,
        "device_id": "950387",
        "latitude": 22.338087,
        "longitude": 114.20182,
        "timestamp": "2025-03-21T16:38:36+08:00",
        "object_location": "/950387/20250321/20250321163836_950387_2.jpg",
        "type_of_event": 3,
        "alarm_type": 0,
        "speed": 27,
        "channel": 1,
        "image_url": "https://ax0s9dy3myes.objectstorage.ap-singapore-1.oci.customer-oci.com/p/Eu1Z_Iun6Du5SDhGw4ToxaaK0Je2iQG9_hnwNmIxJX0P1g8A6kL3kxFK0e6bYl-i/n/ax0s9dy3myes/b/Tbox-Media/o/950387/20250321/20250321163836_950387_2.jpg",
        "image_descriptions": [
            {
                "image_metadata_row_id": 2499308,
                "plate": "la8215",
                "pscore": "1",
                "vscore": "0.25",
                "vehicle": "Van",
                "result": "{"xmin": 851, "ymin": 301, "xmax": 1128, "ymax": 535}",
                "imageUrl": "https://ax0s9dy3myes.objectstorage.ap-singapore-1.oci.customer-oci.com/n/ax0s9dy3myes/b/crop_images/o/la8215_9621018471500.jpg"
            }
        ]
    },
    {
        "row_id": 2543774,
        "device_id": "950449",
        "latitude": 22.277788,
        "longitude": 114.229645,
        "timestamp": "2025-03-21T21:24:21+08:00",
        "object_location": "/950449/20250321/20250321212421_950449_1.jpg",
        "type_of_event": 3,
        "alarm_type": 0,
        "speed": 2,
        "channel": 0,
        "image_url": "https://ax0s9dy3myes.objectstorage.ap-singapore-1.oci.customer-oci.com/p/xByQmAtN1KwVwDfPmDSHClQ-PcOSmM5YyLNZd8E0H0EHZJyt6U8bS30TlrX-_UZZ/n/ax0s9dy3myes/b/Tbox-Media/o/950449/20250321/20250321212421_950449_1.jpg",
        "image_descriptions": [
            {
                "image_metadata_row_id": 2543774,
                "plate": "va6454",
                "pscore": "0.81",
                "vscore": "0.37",
                "vehicle": "Sedan",
                "result": "{"xmin": 886, "ymin": 356, "xmax": 1073, "ymax": 537}",
                "imageUrl": "https://ax0s9dy3myes.objectstorage.ap-singapore-1.oci.customer-oci.com/n/ax0s9dy3myes/b/crop_images/o/va6454_9521011462476.jpg"
            }
        ]
    } ..... 
GEThttps://mqtt-data-pipeline.taxieco-software.com/ws
WebSocket connection endpoint, for real-time data, all mqtt topics are supported

Params

{ type: "auth", data: { token: "your_token_here", } }json (required) - send this object as a stringified JSON object to websocket connection after connection is established
{ type: "subscribe", data: { topic: "topic_name_here", } }json (required) - send this json object to websocket connection
PUThttps://mqtt-data-pipeline.taxieco-software.com/historical/image-metadata
Update the progress of plate recognition

Params

Body

process_statuseither be 'succeed' or 'failed'
row_idthe id of the row in the database, must be a positive integer
process_remarksoptional remarks about the process

Sample Body

{
  process_status: "succeed",
  row_id: 1234567890,
  process_remarks: "optional remarks about the process"
}
GEThttps://mqtt-data-pipeline.taxieco-software.com/historical/image-metadata
Get historical image metadata

Params

fromstring (required) - YYYY-MM-DD/ YYYY-MM-DD HH:MM:SS
tostring (required) - YYYY-MM-DD/ YYYY-MM-DD HH:MM:SS
device-idstring
is-timeboolean

Sample Request

https://mqtt-data-pipeline.taxieco-software.com/historical/image-metadata?from=2025-03-10 02:00:00&to=2025-03-10 10:00:00&device-id=990903&is-time=true

Sample Response

[
    {
        "row_id": 1008633,
        "device_id": "990903",
        "latitude": 22.340658,
        "longitude": 114.19244,
        "timestamp": "2025-03-10T04:05:37+08:00",
        "object_location": "/990903/20250310/20250310040537_990903_3.jpg",
        "type_of_event": 3,
        "alarm_type": 0,
        "speed": null,
        "image_url": "https://ax0s9dy3myes.objectstorage.ap-singapore-1.oci.customer-oci.com/p/eAJ-7FOq_5zlS6dwWR8k0EGa_juUhOq1hQv0Sc90F6892yvdEkgUPs10ZMeBVfpg/n/ax0s9dy3myes/b/Tbox-Media/o/990903/20250310/20250310040537_990903_3.jpg"
    },
    {
        "row_id": 1008638,
        "device_id": "990903",
        "latitude": 22.341463,
        "longitude": 114.19208,
        "timestamp": "2025-03-10T04:06:31+08:00",
        "object_location": "/990903/20250310/20250310040631_990903_2.jpg",
        "type_of_event": 3,
        "alarm_type": 0,
        "speed": null,
        "image_url": "https://ax0s9dy3myes.objectstorage.ap-singapore-1.oci.customer-oci.com/p/eAJ-7FOq_5zlS6dwWR8k0EGa_juUhOq1hQv0Sc90F6892yvdEkgUPs10ZMeBVfpg/n/ax0s9dy3myes/b/Tbox-Media/o/990903/20250310/20250310040631_990903_2.jpg"
    }...]
GEThttps://mqtt-data-pipeline.taxieco-software.com/historical/records
Get historical records for devices

Params

startstring (required) - YYYY-MM-DD HH:MM:SS
endstring (required) - YYYY-MM-DD HH:MM:SS
device-idstring
arrayboolean

Sample Request

https://mqtt-data-pipeline.taxieco-software.com/historical/records?start=2025-03-06 17:00:00&end=2025-03-06 17:10:00

Sample Response


[
    {
        "id": 514318132,
        "time": "2025-02-01T01:46:30+08:00",
        "did": "990903",
        "lat": 22.301168,
        "lng": 114.17551,
        "speed": 24,
        "accel_x": 0.25,
        "accel_y": 0.2,
        "accel_z": -9.74,
        "hx": 106,
        "sn": 31,
        "ol": 1,
        "dt": 3,
        "pk": 0,
        "lc": 18792798,
        "net": 3,
        "gt": null,
        "cputmp": null,
        "volt": null,
        "acc": null,
        "ntsig": null,
        "gps_connect": null,
        "vloss": null,
        "vid": null,
        "created_at": "2025-02-17T10:43:05+08:00",
        "last_updated": null
    }, ...
          
GEThttps://mqtt-data-pipeline.taxieco-software.com/historical/device
Get historical device data

Params

fromstring (required) - YYYY-MM-DD
durationstring (required)
device-idstring (required)

Sample Request

https://mqtt-data-pipeline.taxieco-software.com/historical/device?from=2025-03-06&duration=day&device-id=990901

Sample Response


[
    {
        "id": 586226651,
        "time": "2025-03-06T00:00:00+08:00",
        "did": "990901",
        "lat": 22.29906,
        "lng": 113.970245,
        "speed": 94,
        "accel_x": 0.20199999,
        "accel_y": 0.15047999,
        "accel_z": -9.84116,
        "hx": 255,
        "sn": 24,
        "ol": 1,
        "dt": null,
        "pk": 0,
        "lc": 9018965,
        "net": 3,
        "gt": "2025-02-05T23:59:59+08:00",
        "cputmp": 56,
        "volt": 110,
        "acc": 1,
        "ntsig": 28,
        "gps_connect": 69,
        "vloss": 458752,
        "vid": null,
        "created_at": "2025-03-06T00:00:19+08:00",
        "last_updated": null
    },
    {
        "id": 586226726,
        "time": "2025-03-06T00:00:01+08:00",
        "did": "990901",
        "lat": 22.299002,
        "lng": 113.97001,
        "speed": 94,
        "accel_x": 0.21324,
        "accel_y": 0.15428,
        "accel_z": -9.836999,
        "hx": 255,
        "sn": 20,
        "ol": 1,
        "dt": null,
        "pk": 0,
        "lc": 9019017,
        "net": 3,
        "gt": "2025-02-06T00:00:00+08:00",
        "cputmp": 56,
        "volt": 111,
        "acc": 1,
        "ntsig": 28,
        "gps_connect": 69,
        "vloss": 458752,
        "vid": null,
        "created_at": "2025-03-06T00:00:20+08:00",
        "last_updated": null
    }...
        
GEThttps://mqtt-data-pipeline.taxieco-software.com/historical/nearby
Find devices nearby a location

Params

latnumber (required)
lngnumber (required)
distancenumber (required)
fromstring (required) - YYYY-MM-DD HH:MM
tostring (required) - YYYY-MM-DD HH:MM

Sample Request

https://mqtt-data-pipeline.taxieco-software.com/historical/nearby?lat=22.30603&lng=114.18369&distance=1&from=2025-02-01 00:00&to=2025-02-01 15:00

Sample Response


[
    {
        "id": 514318132,
        "time": "2025-02-01T01:46:30+08:00",
        "did": "990903",
        "lat": 22.301168,
        "lng": 114.17551,
        "speed": 24,
        "accel_x": 0.25,
        "accel_y": 0.2,
        "accel_z": -9.74,
        "hx": 106,
        "sn": 31,
        "ol": 1,
        "dt": 3,
        "pk": 0,
        "lc": 18792798,
        "net": 3,
        "gt": null,
        "cputmp": null,
        "volt": null,
        "acc": null,
        "ntsig": null,
        "gps_connect": null,
        "vloss": null,
        "vid": null,
        "created_at": "2025-02-17T10:43:05+08:00",
        "last_updated": null
    }, ...