Login
FREE TRIAL 30 DAYS
LOG IN
FREE TRIAL

← Back to Sandbox Home

Pairtree Sandbox Documentation
API docs by Redocly

Pairtree Sandbox Documentation (1.0.0)

Download OpenAPI specification:Download

These API endpoints are licenced for testing only. Unauthorised use is not permitted. Pairtree Intelligence takes no responsiblity for the accuracy of the data returned.

Piper Functions

These are functions that are used to help locate information about the current organisation represented as a piper to get the API keys for pipees and the latest postman documentation for the sandbox environment.

Organisation List

This endpoint makes an HTTP GET request to retrieve a list of organizations from the sandbox environment.

Authorizations:
apiKey
header Parameters
apikey-piper
string
Example: string (required)

Responses

Latest Documentation

This endpoint makes an HTTP GET request to retrieve the latest postman documentation in json form that can be added into postman as a collection for setting up a test environment quickly.

Authorizations:
apiKey
header Parameters
apikey-piper
string
Example: string (required)

Responses

Functions

Piper Function management endpoints. For each of these calls you will need 2 keys apikey-piper and apikey-org. Find your pipee keys using the piper api functions.

sb_grower_farm_field

This function can be used to obtain the paddock area for a location

Authorizations:
apiKey
query Parameters
location_id
string
Example: location_id=integer (required)
page_size
string
Example: page_size=integer (default:1,000, max:10,000)
page_number
string
Example: page_number=integer (default:1)
header Parameters
apikey-org
string
Example: string (required)

Responses

sb_grower_farm_field

This function can be used to obtain the paddock area for a location

Authorizations:
apiKey
header Parameters
apikey-org
string
Example: string (required)
Request Body schema: application/json
location_id
string
page_number
string
page_size
string

Responses

Request samples

Content type
application/json
{
  • "location_id": "integer (required)",
  • "page_number": "integer (default:1)",
  • "page_size": "integer (default:1,000, max:10,000)"
}

sb_locations

This function will return a list of location that belong to or can be accessed by the organization.

Authorizations:
apiKey
query Parameters
page_size
string
Example: page_size=integer (default:1,000, max:10,000)
page_number
string
Example: page_number=integer (default:1)
header Parameters
apikey-org
string
Example: string (required)

Responses

sb_locations

This function will return a list of location that belong to or can be accessed by the organization.

Authorizations:
apiKey
header Parameters
apikey-org
string
Example: string (required)
Request Body schema: application/json
page_number
string
page_size
string

Responses

Request samples

Content type
application/json
{
  • "page_number": "integer (default:1)",
  • "page_size": "integer (default:1,000, max:10,000)"
}

sb_devices

This function will return a list of all the devices that are located at a specific location.

Authorizations:
apiKey
query Parameters
location_id
string
Example: location_id=integer
supplier_name
string
Example: supplier_name=text
page_size
string
Example: page_size=integer (default:1,000, max:10,000)
page_number
string
Example: page_number=integer (default:1)
header Parameters
apikey-org
string
Example: string (required)

Responses

sb_devices

This function will return a list of all the devices that are located at a specific location.

Authorizations:
apiKey
header Parameters
apikey-org
string
Example: string (required)
Request Body schema: application/json
location_id
string
page_number
string
page_size
string
supplier_name
string

Responses

Request samples

Content type
application/json
{
  • "location_id": "integer",
  • "page_number": "integer (default:1)",
  • "page_size": "integer (default:1,000, max:10,000)",
  • "supplier_name": "text"
}

sb_tank_sensor

This function can be used to obtain the tank sensor readings for an org, location or individual device. Default output produces 30 days of data for all sensors at the specified org.

Authorizations:
apiKey
query Parameters
location_id
string
Example: location_id=integer
device_id
string
Example: device_id=integer
date_from
string
Example: date_from=text
date_to
string
Example: date_to=text
page_size
string
Example: page_size=integer (default:1,000, max:10,000)
page_number
string
Example: page_number=integer (default:1)
header Parameters
apikey-org
string
Example: string (required)

Responses

sb_tank_sensor

This function can be used to obtain the tank sensor readings for an org, location or individual device. Default output produces 30 days of data for all sensors at the specified org.

Authorizations:
apiKey
header Parameters
apikey-org
string
Example: string (required)
Request Body schema: application/json
date_from
string
date_to
string
device_id
string
location_id
string
page_number
string
page_size
string

Responses

Request samples

Content type
application/json
{
  • "date_from": "text",
  • "date_to": "text",
  • "device_id": "integer",
  • "location_id": "integer",
  • "page_number": "integer (default:1)",
  • "page_size": "integer (default:1,000, max:10,000)"
}

sb_spray_condition

This function can be used to obtain a spray condition report for the specified org/location, for the hour preceding the specified time. Output can be requested from the nearest physical, virtual or both (any nearest station).

Authorizations:
apiKey
query Parameters
datetime
string
Example: datetime=text (required)
timezone
string
Example: timezone=text
paddock_name
string
Example: paddock_name=text
latitude
string
Example: latitude=text
longitude
string
Example: longitude=text
physical
string
Example: physical=boolean
page_size
string
Example: page_size=integer (default:1,000, max:10,000)
page_number
string
Example: page_number=integer (default:1)
header Parameters
apikey-org
string
Example: string (required)

Responses

sb_spray_condition

This function can be used to obtain a spray condition report for the specified org/location, for the hour preceding the specified time. Output can be requested from the nearest physical, virtual or both (any nearest station).

Authorizations:
apiKey
header Parameters
apikey-org
string
Example: string (required)
Request Body schema: application/json
datetime
string
latitude
string
longitude
string
paddock_name
string
page_number
string
page_size
string
physical
string
timezone
string

Responses

Request samples

Content type
application/json
{
  • "datetime": "text (required)",
  • "latitude": "text",
  • "longitude": "text",
  • "paddock_name": "text",
  • "page_number": "integer (default:1)",
  • "page_size": "integer (default:1,000, max:10,000)",
  • "physical": "boolean",
  • "timezone": "text"
}

sb_get_area

This function can be used to obtain the land area of an org by location, paddock name or filter by paddock names. Returns area in hectares.

Authorizations:
apiKey
query Parameters
location_id
string
Example: location_id=integer
show_paddocks
string
Example: show_paddocks=boolean
paddock_name_like
string
Example: paddock_name_like=text
page_size
string
Example: page_size=integer (default:1,000, max:10,000)
page_number
string
Example: page_number=integer (default:1)
header Parameters
apikey-org
string
Example: string (required)

Responses

sb_get_area

This function can be used to obtain the land area of an org by location, paddock name or filter by paddock names. Returns area in hectares.

Authorizations:
apiKey
header Parameters
apikey-org
string
Example: string (required)
Request Body schema: application/json
location_id
string
paddock_name_like
string
page_number
string
page_size
string
show_paddocks
string

Responses

Request samples

Content type
application/json
{
  • "location_id": "integer",
  • "paddock_name_like": "text",
  • "page_number": "integer (default:1)",
  • "page_size": "integer (default:1,000, max:10,000)",
  • "show_paddocks": "boolean"
}

sb_get_geojson

This function can be used to obtain all geoJSON's for an org, or for a specific location with an optional parameter.

Authorizations:
apiKey
query Parameters
location_id
string
Example: location_id=integer
page_size
string
Example: page_size=integer (default:1,000, max:10,000)
page_number
string
Example: page_number=integer (default:1)
header Parameters
apikey-org
string
Example: string (required)

Responses

sb_get_geojson

This function can be used to obtain all geoJSON's for an org, or for a specific location with an optional parameter.

Authorizations:
apiKey
header Parameters
apikey-org
string
Example: string (required)
Request Body schema: application/json
location_id
string
page_number
string
page_size
string

Responses

Request samples

Content type
application/json
{
  • "location_id": "integer",
  • "page_number": "integer (default:1)",
  • "page_size": "integer (default:1,000, max:10,000)"
}

sb_historic_weather

This function can be used to obtain the historic weather for the specified location. Output can be requested as an average (per day of the year) or raw data. Default output produces an average for each day of the year using 100 years of data at the specified org and location(s).

Authorizations:
apiKey
query Parameters
location_id
string
Example: location_id=integer
date_from
string
Example: date_from=text
date_to
string
Example: date_to=text
output_average
string
Example: output_average=boolean
page_size
string
Example: page_size=integer (default:1,000, max:10,000)
page_number
string
Example: page_number=integer (default:1)
header Parameters
apikey-org
string
Example: string (required)

Responses

sb_historic_weather

This function can be used to obtain the historic weather for the specified location. Output can be requested as an average (per day of the year) or raw data. Default output produces an average for each day of the year using 100 years of data at the specified org and location(s).

Authorizations:
apiKey
header Parameters
apikey-org
string
Example: string (required)
Request Body schema: application/json
date_from
string
date_to
string
location_id
string
output_average
string
page_number
string
page_size
string

Responses

Request samples

Content type
application/json
{
  • "date_from": "text",
  • "date_to": "text",
  • "location_id": "integer",
  • "output_average": "boolean",
  • "page_number": "integer (default:1)",
  • "page_size": "integer (default:1,000, max:10,000)"
}

sb_virtual_weather

This function can be used to obtain the latest weather data for the specified device.

Authorizations:
apiKey
query Parameters
location_id
string
Example: location_id=integer
data_supplier
string
Example: data_supplier=text
page_size
string
Example: page_size=integer (default:1,000, max:10,000)
page_number
string
Example: page_number=integer (default:1)
header Parameters
apikey-org
string
Example: string (required)

Responses

sb_virtual_weather

This function can be used to obtain the latest weather data for the specified device.

Authorizations:
apiKey
header Parameters
apikey-org
string
Example: string (required)
Request Body schema: application/json
data_supplier
string
location_id
string
page_number
string
page_size
string

Responses

Request samples

Content type
application/json
{
  • "data_supplier": "text",
  • "location_id": "integer",
  • "page_number": "integer (default:1)",
  • "page_size": "integer (default:1,000, max:10,000)"
}

sb_weather_forecast

This function can be used to obtain the weather forecast for the specified location.

Authorizations:
apiKey
query Parameters
location_id
string
Example: location_id=integer
data_supplier
string
Example: data_supplier=text
date_from
string
Example: date_from=text
date_to
string
Example: date_to=text
page_size
string
Example: page_size=integer (default:1,000, max:10,000)
page_number
string
Example: page_number=integer (default:1)
header Parameters
apikey-org
string
Example: string (required)

Responses

sb_weather_forecast

This function can be used to obtain the weather forecast for the specified location.

Authorizations:
apiKey
header Parameters
apikey-org
string
Example: string (required)
Request Body schema: application/json
data_supplier
string
date_from
string
date_to
string
location_id
string
page_number
string
page_size
string

Responses

Request samples

Content type
application/json
{
  • "data_supplier": "text",
  • "date_from": "text",
  • "date_to": "text",
  • "location_id": "integer",
  • "page_number": "integer (default:1)",
  • "page_size": "integer (default:1,000, max:10,000)"
}

sb_rainfall

This function can be used to obtain the rainfall readings for a location or individual device. Default output produces 90 days of data for all sensors at the specified org.

Authorizations:
apiKey
query Parameters
location_id
string
Example: location_id=integer
device_id
string
Example: device_id=integer
date_from
string
Example: date_from=text
date_to
string
Example: date_to=text
page_size
string
Example: page_size=integer (default:1,000, max:10,000)
page_number
string
Example: page_number=integer (default:1)
header Parameters
apikey-org
string
Example: string (required)

Responses

sb_rainfall

This function can be used to obtain the rainfall readings for a location or individual device. Default output produces 90 days of data for all sensors at the specified org.

Authorizations:
apiKey
header Parameters
apikey-org
string
Example: string (required)
Request Body schema: application/json
date_from
string
date_to
string
device_id
string
location_id
string
page_number
string
page_size
string

Responses

Request samples

Content type
application/json
{
  • "date_from": "text",
  • "date_to": "text",
  • "device_id": "integer",
  • "location_id": "integer",
  • "page_number": "integer (default:1)",
  • "page_size": "integer (default:1,000, max:10,000)"
}

sb_get_optiweigh

This function can be used to obtain the land area of an org by location, paddock name or filter by paddock names. Returns area in hectares.

Authorizations:
apiKey
query Parameters
location_id
string
Example: location_id=text
session_name
string
Example: session_name=text
session_start
string
Example: session_start=text
page_size
string
Example: page_size=integer (default:1,000, max:10,000)
page_number
string
Example: page_number=integer (default:1)
header Parameters
apikey-org
string
Example: string (required)

Responses

sb_get_optiweigh

This function can be used to obtain the land area of an org by location, paddock name or filter by paddock names. Returns area in hectares.

Authorizations:
apiKey
header Parameters
apikey-org
string
Example: string (required)
Request Body schema: application/json
location_id
string
page_number
string
page_size
string
session_name
string
session_start
string

Responses

Request samples

Content type
application/json
{
  • "location_id": "text",
  • "page_number": "integer (default:1)",
  • "page_size": "integer (default:1,000, max:10,000)",
  • "session_name": "text",
  • "session_start": "text"
}

Pairtree Pipes Sandbox (API demo)

contact us:

follow us:

Facebook-f Instagram X-twitter Linkedin

business hours:

  • Monday to Friday: 9am - 5pm
  • Saturday & Sunday: Closed

Website by Kee Websites

Copyright © 2024 Pairtree Intelligence Pty Ltd

Terms & Conditions | Privacy Policy

stay in
the
know

get THE latest updates

Sign up to our e-News and be the first to hear about Pairtree’s latest offers & news and receive fresh insights on new trends in Australian farming and agricultural technology.