Sandbox API Reference Document

Pairtree Pipes Sandbox

Pairtree Pipes Sandbox (v1.3)

Download OpenAPI specification:Download

API Functions Manual for Pairtree Pipes Sandbox.
This manual will be updated from time to time so please save the link rather than the document.

SBX Get Client API Keys

This endpoint should be used to access Sandbox ORG API Keys for testing

Authorizations:
apikey-piper

Responses

Response samples

Content type
application/json
{ }

SBX Get Org Information

This function can be used to obtain information about the org_id queried. e.g. https://my.pairtree.co/pairtree/v2/api/function/s_org_v1/execute?data_org_id=231

Authorizations:
(apikey-piperapikey-client)
query Parameters
data_org_id
any <int4>

Org Id being queried, for sandbox use 231

header Parameters
apikey-client
required
any

Enter the client (sandbox org) api key you wish to query, get these from the /pipes/piper/client/ endpoint

apikey-piper
required
any

Enter your API Key. This key was emailed to you on account verification

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "abn": "string",
  • "geo": "string",
  • "city": "string",
  • "core": "string",
  • "guid": "string",
  • "name": "string",
  • "pass": "string",
  • "plan": "string",
  • "ap_id": "string",
  • "email": "string",
  • "pt_id": "string",
  • "state": "string",
  • "active": "string",
  • "dbpass": "string",
  • "ocpass": "string",
  • "ocuser": "string",
  • "parent": "string",
  • "status": "string",
  • "country": "string",
  • "created": "string",
  • "updated": "string",
  • "address1": "string",
  • "address2": "string",
  • "latitude": "string",
  • "welcomed": "string",
  • "zip_code": "string",
  • "farm_name": "string",
  • "longitude": "string",
  • "customer_of": "string",
  • "billing_name": "string",
  • "phone_number": "string",
  • "trading_name": "string",
  • "billing_email": "string",
  • "stripe_customer": "string",
  • "provision_status": "string"
}

SBX 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-piperapikey-client)
query Parameters
data_org_id
required
any <int4>

Org Id being queried

location_id
any <int4>

Location Id being queried

show_paddocks
any <bool>

'true' will show areas based on paddock names, false will group by location

paddock_name_like
any <text>

Returns paddocks where paddock_name is like this entry

header Parameters
apikey-client
required
any

Enter the client (sandbox org) api key you wish to query, get these from the /pipes/piper/client/ endpoint

apikey-piper
required
any

Enter your API Key. This key was emailed to you on account verification

Responses

Response samples

Content type
application/json
{
  • "map_area": "string",
  • "location_id": "string",
  • "paddock_name": "string",
  • "location_name": "string"
}

SBX Rainfall

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

Authorizations:
(apikey-piperapikey-client)
query Parameters
data_org_id
required
any <int4>

Org Id being queried

location_id
any <int4>

Location Id being queried, default is null for all locations in that org

device_id
any <int4>

The Device ID being queried, default is null which returns all devices at that location/org

date_from
any <text>

The date you want the history from, defaults to 30 days before today, format of 'yyyy-mm-dd' e.g. '2023-07-02'.

date_to
any <text>

The date you want the history to, defaults to today, format of 'yyyy-mm-dd' e.g. '2023-08-01'.

header Parameters
apikey-client
required
any

Enter the client (sandbox org) api key you wish to query, get these from the /pipes/piper/client/ endpoint

apikey-piper
required
any

Enter your API Key. This key was emailed to you on account verification

Responses

Response samples

Content type
application/json
{
  • "lat": "string",
  • "long": "string",
  • "value": "string",
  • "dev_id": "string",
  • "loc_id": "string",
  • "dev_name": "string",
  • "loc_name": "string",
  • "supplier": "string",
  • "data_date": "string"
}

SBX 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-piperapikey-client)
query Parameters
data_org_id
required
any <int4>

Org Id being queried

location_id
any <int4>

this is an optional field

header Parameters
apikey-client
required
any

Enter the client (sandbox org) api key you wish to query, get these from the /pipes/piper/client/ endpoint

apikey-piper
required
any

Enter your API Key. This key was emailed to you on account verification

Responses

Response samples

Content type
application/json
{
  • "geojson": "string",
  • "location_id": "string",
  • "location_name": "string"
}

SBX 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-piperapikey-client)
query Parameters
data_org_id
required
any <int4>

Org Id being queried

location_id
any <int4>

Location Id being queried, default is null for all locations in that org

device_id
any <int4>

The Device ID being queried, default is null which returns all devices at that location/org

date_from
any <text>

The date you want the history from, defaults to 100 years before today, format of 'yyyy-mm-dd hh:mm:ss' e.g. '2023-01-01 00:00:00'.

date_to
any <text>

The date you want the forecast to, defaults to today at 00:00:00, format of 'yyyy-mm-dd hh:mm:ss' e.g. '2023-01-01 00:00:00'.

header Parameters
apikey-client
required
any

Enter the client (sandbox org) api key you wish to query, get these from the /pipes/piper/client/ endpoint

apikey-piper
required
any

Enter your API Key. This key was emailed to you on account verification

Responses

Response samples

Content type
application/json
{
  • "lat": "string",
  • "long": "string",
  • "value": "string",
  • "dev_id": "string",
  • "loc_id": "string",
  • "dev_name": "string",
  • "loc_name": "string",
  • "supplier": "string",
  • "event_time": "string"
}

SBX 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-piperapikey-client)
query Parameters
data_org_id
required
any <int4>

Org Id being queried

datetime
required
any <text>

The datetime (in format of YYYY-MM-DD hh:mm:ss) for the Spray Condition Report, response will be provided based on available data from the hour prior to the provided time.
Assumes Timezone of the paddock/coordinates provided unless specified in the timezone parameter.

timezone
any <text>

The timezone of the Date Time field, defaults to the paddock/coordinates timezone if not specified. Format as +/-hh:mm, e.g. +10:00 or -8:00.

paddock_name
any <text>

Paddock Name (from within the Query Org Id) to be queried

latitude
any <text>

Latitude for location being queried

longitude
any <text>

Longitude for location being queried

physical
any <bool>

True for Physical Stations, False for Virtual Stations, and null (or default) for any station.

header Parameters
apikey-client
required
any

Enter the client (sandbox org) api key you wish to query, get these from the /pipes/piper/client/ endpoint

apikey-piper
required
any

Enter your API Key. This key was emailed to you on account verification

Responses

Response samples

Content type
application/json
{
  • "tz_out": "string",
  • "result_out": "string",
  • "delta_t_out": "string",
  • "rel_hum_out": "string",
  • "calc_lat_out": "string",
  • "datetime_out": "string",
  • "distance_out": "string",
  • "supplier_out": "string",
  • "temp_max_out": "string",
  • "temp_min_out": "string",
  • "calc_long_out": "string",
  • "station_name_out": "string",
  • "main_wind_dir_out": "string",
  • "wind_gust_max_out": "string"
}

SBX Virtual Weather

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

Authorizations:
(apikey-piperapikey-client)
query Parameters
data_org_id
required
any <int4>

Org Id being queried

location_id
any <int4>

Location Id being queried

data_supplier
any <text>

description9

header Parameters
apikey-client
required
any

Enter the client (sandbox org) api key you wish to query, get these from the /pipes/piper/client/ endpoint

apikey-piper
required
any

Enter your API Key. This key was emailed to you on account verification

Responses

Response samples

Content type
application/json
{
  • "uom": "string",
  • "value": "string",
  • "metric": "string",
  • "last_updated": "string"
}

SBX Historic Weather

This function can be used to obtain the historic weather for the specified org/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-piperapikey-client)
query Parameters
data_org_id
required
any <int4>

Org Id being queried

location_id
any <int4>

dafault is null for all locations in that org

date_from
any <text>

The date you want the history from, defaults to 100 years before today.

date_to
any <text>

The date you want the forecast to, defaults to today.

output_average
any <bool>

defaults to true.

header Parameters
apikey-client
required
any

Enter the client (sandbox org) api key you wish to query, get these from the /pipes/piper/client/ endpoint

apikey-piper
required
any

Enter your API Key. This key was emailed to you on account verification

Responses

Response samples

Content type
application/json
{
  • "loc_id": "string",
  • "loc_name": "string",
  • "rainfall": "string",
  • "temp_max": "string",
  • "temp_min": "string",
  • "data_date": "string",
  • "evaporation": "string",
  • "output_type": "string"
}

SBX Weather Forecast

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

Authorizations:
(apikey-piperapikey-client)
query Parameters
data_org_id
required
any <int4>

Org Id being queried

location_id
any <int4>

Location Id being queried

data_supplier
any <text>

Name of the supplier being queried

date_from
any <text>

The date you want the forecast from, defaults to Today (midnight)

date_to
any <text>

The date you want the forecast to, defaults to 7 days from Today (23:59:59)

header Parameters
apikey-client
required
any

Enter the client (sandbox org) api key you wish to query, get these from the /pipes/piper/client/ endpoint

apikey-piper
required
any

Enter your API Key. This key was emailed to you on account verification

Responses

Response samples

Content type
application/json
{
  • "uom": "string",
  • "value": "string",
  • "metric": "string",
  • "event_time": "string"
}

SBX Grower Farm Field

This function can be used to obtain the paddock area for an org, location

Authorizations:
(apikey-piperapikey-client)
query Parameters
data_org_id
required
any <int4>

Org Id being queried

location_id
required
any <int4>

Location Id being queried, default is null for all locations in that org

header Parameters
apikey-client
required
any

Enter the client (sandbox org) api key you wish to query, get these from the /pipes/piper/client/ endpoint

apikey-piper
required
any

Enter your API Key. This key was emailed to you on account verification

Responses

Response samples

Content type
application/json
{
  • "uom": "string",
  • "area": "string",
  • "loc_id": "string",
  • "org_id": "string",
  • "loc_name": "string",
  • "org_name": "string",
  • "paddock_name": "string"
}

Pairtree Pipes Sandbox (API demo)

Pairtree Pipes Sandbox (API demo)

Pairtree Pipes Sandbox (API demo)

Pairtree Pipes Sandbox (API demo)

Pairtree Pipes Sandbox (API demo)

learn more about pairtree

Please complete the form below and a member of our support team willl be in touch shortly.

I primarily farm:
I am interested in:
More Information:

sign up for 30-day free trial

Please complete the form below and a member of our support team will be in touch shortly.

preferred main weather forecast location LATITUDE & LONGITUDE (to 6 decimal places):
Upload farm map or maps (kmz, kml, shp, geojson format):
I primarily farm:
Type and brand of Existing Agtech on my farm:
how did you hear about pairtree?
SIgn me up:

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.