Tractors

Tractors form the core of the Hello Tractor ecosystem. The Hello Tractor API provides endpoints to manage and retrieve information about tractors. These endpoints allow you to get details about all available tractors or a specific tractor using its unique identifier..

The tractor model

A tractor model is comprised of the following.

Properties

  • Name
    tractor_id
    Type
    number
    Description

    Unique identifier for the tractor.

  • Name
    tractor_name
    Type
    string
    Description

    Name of the tractor.

  • Name
    tractor_location
    Type
    object
    Description

    Location details of the the tractor.

  • Name
    implements_attached
    Type
    array
    Description

    Implements attached to the tractor.


GET/v1/tractors

List all available tractors

This endpoint allows you to retrieve a paginated list of all available tractors. By default, a maximum of 25 tractors are shown per page.

Optional attributes

  • Name
    limit
    Type
    integer
    Description

    Limit the number of tractors returned.

Request

GET
/v1/tractors
curl -G https://api.hellotractor.com/v1/tractors \
  -H "Authorization: Bearer {token}" \
  -d limit=10

Response

{
  "data": [
    {
      "tractor_id": "435345",
      "tractor_name": "Kuboto X5",
      "tractor_location": {
        "country": "Nigeria",
        "state": "Lagos",
        "city": "Ikeja",
      },
      "implements_attached": [
        "plough",
        "harrow",
      ],
    },
    {
      "id": "654556",
      // ...
    }
  ]
}

GET/v1/tractors/:tractor_id

Retrieve a tractor

This endpoint allows you to retrieve a tractor details using the tractor id. Refer to the list at the top of this page to see which properties are included with tractor objects.

Request

GET
/v1/tractors/435345
curl https://api.hellotractor.com/v1/tractors/435345 \
  -H "Authorization: Bearer {token}"

Response

{
  "tractor_id": "435345",
  "tractor_name": "Kuboto X5",
  "tractor_location": {
      "country": "Nigeria",
      "state": "Lagos",
      "city": "Ikeja",
    },
  "implements_attached": ["plough","harrow"],
}

Was this page helpful?