API reference

Point data

API request returns a single point dataset.

Attributes

The attributes for a point data request vary depending on the format and data type requested. To request data at a station location, the station parameter must be specified. To request data at a grid location, the lat and lon parameters must be specified. These parameters are described in the table below.

Routes

Get point data

HTTP method GET
URI /pointdata
Parameters
Name Required Default Type Description
api_key yes string Your API key.
start yes string The first date to get data for, formatted as YYYYMMDD , for example, 20160101.
finish yes string The last date to get data for, formatted as YYYYMMDD , for example, 20160101.
station no int The station number to get data for, for example, 40004. Required if lat and lon aren't specified.
lat no float The latitude of a grid point to get data for, for example, -34.05. Required if station is not specified. lon must also be specified. Latitudes must be specified to the nearest 0.05°.
lon no float The longitude of a grid point to get data for, for example, 127.5. Required if station is not specified. lat must also be specified. Longitudes must be specified to the nearest 0.05°.
format yes string The format to get data in. Valid formats include json and csv (for customised formats), and standard, alldata, apsim, p51, cenw, monthly and century (for standard formats).
variables no list[string] Variables to get data for, if the format is not a predefined format. Required if format is csv or json. Specify as a comma separated list of variable codes, for example max_temp,min_temp,vp. The variable codes (e.g. max_temp) are provided on the Variables page, or you can query them using the API (see the example).
user_ref no string An optional string that is inserted in the comment field which is available in some data formats.

NOTE: you will need to substitute your API key for all the example requests below.

Example request - data for January 2016, station 40004, in JSON format, for maximum and minimum temperature
https://siloapi.longpaddock.qld.gov.au/pointdata?apikey={YOUR_API_KEY}&start=20160101&finish=20160131&station=40004&format=json&variables=max_temp,min_temp
Example request - data for January 2016, station 40004, in APSIM format
https://siloapi.longpaddock.qld.gov.au/pointdata?apikey={YOUR_API_KEY}&start=20160101&finish=20160131&station=40004&format=apsim
Example request - data for January 2016, latitude -27.5 and longitude 135.0, in JSON format, for maximum and minimum temperature
https://siloapi.longpaddock.qld.gov.au/pointdata?apikey={YOUR_API_KEY}&start=20160101&finish=20160131&lat=-27.5&lon=135.0&format=json&variables=max_temp,min_temp

The response for a point data request will vary depending on the format requested. Please see the file formats and samples page for a sample of each format.

Back to top

Stations

API request returns information about the observing stations from which point datasets are available.

Attributes

Attribute Type Description
number int A unique numeric identifier.
name string The name of the station.
latitude float The latitude of the station in GDA94.
longitude float The longitude of the station in GDA94.
elevation int The elevation of the station, measured as meters above sea level.
supplier string The organisation that manages the station.
start_year int The year this station became active (started making observations).
end_year int The year this station closed (stopped taking observations). The end year is null if the station is still active.
distance float The distance from this station to the station being searched around, in kilometres. Only returned in a search with a near parameter.
observed_variables list[string] The variables that are directly observed by this station. Only returned in a search with a statistics parameter. In JSON, this is returned as a list of strings. In CSV, each variable is returned as its own row.
statistics statistic The statistics about the variables observed by this station. Only returned in a search with a statistics parameter. In JSON, this is returned as an object containing the relevant information (see example responses below). In CSV, each variable is returned as its own row. The number associated with each variable is the number of observations available in the given time period (year or decade).

Routes

Get details of all stations

HTTP method GET
URI /stations
Parameters
Name Required Default Type Description
near no int The number of the station to perform a radius search around.
radius no 10 int The radius to search around the specified station, in kilometres. This parameter has a maximum of 100km.
statistics no string The granularity of station statistics to return. If this parameter is not supplied, no statistics are returned. Can be either yearly or decadal. See the example response for a single station (below) for an indication of what fields are returned if this parameter is set.
format no json string The format to get metadata in. Can be either json or csv.

Example request
https://siloapi.longpaddock.qld.gov.au/stations
Sample responses
JSON

{
"data": [
    {
        "end_year":1983,
        "supplier":"Bureau of Meteorology",
        "elevation":320.0,
        "name":"KARUNJIE",
        "longitude":127.1956,
        "number":1000,
        "latitude":-16.2919,
        "start_year":1940
    },
    {
        "end_year":2012,
        "supplier":"Bureau of Meteorology",
        "elevation":2.0,
        "name":"OOMBULGURRI",
        "longitude":127.8456,
        "number":1001,
        "latitude":-15.1806,
        "start_year":1914
    },
    ...
]
}
    
CSV

"name","number","start_year","end_year","supplier","latitude","longitude","elevation"
"KARUNJIE","1000","1940","1983","Bureau of Meteorology","-16.2919","127.1956","320.0"
"OOMBULGURRI","1001","1914","2012","Bureau of Meteorology","-15.1806","127.8456","2.0"
    
JSON (radius search)

{
"data": [
    {
        "end_year":1983,
        "supplier":"Bureau of Meteorology",
        "elevation":320.0,
        "name":"KARUNJIE",
        "longitude":127.1956,
        "number":1000,
        "latitude":-16.2919,
        "start_year":1940,
        "distance":0.0
    },
    {
        "end_year":null,
        "supplier":"Bureau of Meteorology",
        "elevation":300.0,
        "name":"ELLENBRAE",
        "longitude":127.0628,
        "number":1024,
        "latitude":-15.9572,
        "start_year":1986,
        "distance":39.829
    },
    ...
]
}
        
CSV (radius search)

"name","number","start_year","end_year","supplier","latitude","longitude","elevation","distance"
"KARUNJIE","1000","1940","1983","Bureau of Meteorology","-16.2919","127.1956","320.0","0.0"
"ELLENBRAE","1024","1986","","Bureau of Meteorology","-15.9572","127.0628","300.0","39.829"
        


Get details of a single station

HTTP method GET
URI /stations/:station_number
Parameters
Name Required Default Type Description
station_number yes int The number of the station to get data for.
statistics no string The granularity of station statistics to return. If this parameter is not supplied, no statistics are returned. Can be either yearly or decadal. When returning decadal statistics, the year response field refers to the first year of the decade.
format no json string The format to get metadata in. Can be either json or csv.
Example request
https://siloapi.longpaddock.qld.gov.au/stations/40004
Sample responses
JSON

{
"data": {
    "elevation":24.2,
    "name":"AMBERLEY AMO",
    "start_year":1941,
    "supplier":"Bureau of Meteorology",
    "latitude":-27.6297,
    "number":40004,
    "end_year":null,
    "longitude":152.7111
}
}
    
CSV

"name","number","start_year","end_year","supplier","latitude","longitude","elevation"
"AMBERLEY AMO","40004","1941","","Bureau of Meteorology","-27.6297","152.7111","24.2"
    
JSON (with statistics)

{
"data": {
    "name": "Station 1",
    "number": 1,
    "start_year": 1889,
    "end_year": 2016,
    "supplier": "Bureau of Meteorology",
    "latitude": -20
    "longitude": 120,
    "elevation": 0,
    "observed_variables": [
        "min_temp",
        "daily_rain",
        "max_temp",
        "evap_pan"
    ],
    "statistics": [
        ...
        {
            "year": 2000,
            "min_temp": 0,
            "daily_rain": 0,
            "max_temp": 0,
            "evap_pan": 0
        },
        {
            "year": 2010,
            "min_temp": 352,
            "daily_rain": 491,
            "max_temp": 398,
            "evap_pan": 357
        }
    ]
}
}
    
CSV (with statistics)

"name","number","start_year","end_year","supplier","latitude","longitude","elevation","variable","1880","1890","1900","1910","1920","1930","1940","1950","1960","1970","1980","1990","2000","2010"
"KARUNJIE","1000","1940","1983","Bureau of Meteorology","-16.2919","127.1956","320.0","mslp","0","0","0","0","0","0","0","0","0","0","0","0","0","358"
"KARUNJIE","1000","1940","1983","Bureau of Meteorology","-16.2919","127.1956","320.0","max_temp","0","0","0","0","0","0","0","0","0","0","0","0","0","398"
"KARUNJIE","1000","1940","1983","Bureau of Meteorology","-16.2919","127.1956","320.0","monthly_rain","0","0","0","0","0","0","0","0","0","0","0","0","0","17"
"KARUNJIE","1000","1940","1983","Bureau of Meteorology","-16.2919","127.1956","320.0","evap_pan","0","0","0","0","0","0","0","0","0","0","0","0","0","357"
"KARUNJIE","1000","1940","1983","Bureau of Meteorology","-16.2919","127.1956","320.0","vp","0","0","0","0","0","0","0","0","0","0","0","0","0","290"
"KARUNJIE","1000","1940","1983","Bureau of Meteorology","-16.2919","127.1956","320.0","min_temp","0","0","0","0","0","0","0","0","0","0","0","0","0","352"
"KARUNJIE","1000","1940","1983","Bureau of Meteorology","-16.2919","127.1956","320.0","daily_rain","0","0","0","0","0","0","0","0","0","0","0","0","0","491"
    
Back to top

Variables

API request returns information about the climate and rainfall variables contained in point datasets.

Attributes

Attribute Type Description
name string The name of the variable.
code string A code used to identify the variable in API requests and CSV and JSON data formats (see the table below).
units string The units which this variable is provided in.

Please see the climate variables page for information about variables.

Routes

Get details of all variables

HTTP method GET
URI /variables
Parameters
Name Required Default Type Description
format no json string The format to get metadata in. Can be either json or csv.
Example request
https://siloapi.longpaddock.qld.gov.au/variables
Sample responses
JSON

{
"data": [
    {
        "units":"mm",
        "code":"daily_rain",
        "name":"Daily rainfall"
    },
    {
        "units":"mm",
        "code":"monthly_rain",
        "name":"Monthly rainfall"
    },
    ...
]
}
    
CSV

"name","code","units"
"Daily rainfall","daily_rain","mm"
"Monthly rainfall","monthly_rain","mm"
    

Get details of a single variable

HTTP method GET
URI /variables/:variable_code
Parameters
Name Required Default Type Description
variable_code yes string The code of the variable to get data for.
format no json string The format to get metadata in. Can be either json or csv.
Example request
https://siloapi.longpaddock.qld.gov.au/variables/max_temp
Sample responses
JSON

{
"data": {
    "units":"Celcius",
    "code":"max_temp",
    "name":"Maximum Temperature"
}
}
    
CSV

"name","code","units"
"Maximum temperature","max_temp","Celsius"
    
Back to top

Sources

API request returns information about the source codes associated with values in point datasets.

NOTE: the "source" describes the data type (eg. observed, interpolated etc), whereas the "supplier" is the organisation which has supplied or generated the data.

Attributes

Attribute Type Description
code string A unique numeric code, as described here.
description string A description of the source.
supplier string The organisation which supplies or generates the data.

Routes

Get details of all sources

HTTP method GET
URI /sources
Parameters
Name Required Default Type Description
format no json string The format to get metadata in. Can be either json or csv.
Example request
https://siloapi.longpaddock.qld.gov.au/sources
Sample responses
JSON

{
"data": [
    {
        "description":"Official observation as supplied by the Bureau of Meteorology",
        "code":0,
        "supplier":"Bureau of Meteorology"
    },
    {
        "code":25,
        "description":"Interpolated from daily observations for that date",
        "supplier":"Department of Environment and Science"
    },
    ...
]
}
    
CSV

"code","description","supplier"
"0","Official observation as supplied by the Bureau of Meteorology","Bureau of Meteorology"
"25","Interpolated from daily observations for that date","Department of Environment and Science"
    

Get details of a single source

HTTP method GET
URI /sources/:source_code
Parameters
Name Required Default Type Description
source_code yes string The source code to get metadata for.
format no json string The format to get metadata in. Can be either json or csv.
Example request
https://siloapi.longpaddock.qld.gov.au/sources/0
Sample responses
JSON

{
"data": {
    "description":"Official observation as supplied by the Bureau of Meteorology",
    "code":0,
    "supplier":"Bureau of Meteorology"
}
}
    
CSV

"code","description","supplier"
"0","Official observation as supplied by the Bureau of Meteorology","Bureau of Meteorology"
    
Back to top

Suppliers

API request returns information about the supplier organisations which are associated with stations and sources.

Attributes

Attribute Type Description
name string The name of the supplier.

Routes

Get details of all suppliers

HTTP method GET
URI /suppliers
Parameters
Name Required Default Type Description
format no json string The format to get metadata in. Can be either json or csv.
Example request
https://siloapi.longpaddock.qld.gov.au/suppliers
Sample responses
JSON

{
"data": [
    {
        "name":"Bureau of Meteorology"
    },
    {
        "name":"Department of Environment and Science"
    },
    ...
]
}
    
CSV

"name"
"Bureau of Meteorology"
"Department of Environment and Science"
    

Get details of a single supplier

HTTP method GET
URI /suppliers/:supplier_name
Parameters
Name Required Default Type Description
supplier_name yes string The name of the supplier to get data for.
format no json string The format to get metadata in. Can be either json or csv.
Example request
https://siloapi.longpaddock.qld.gov.au/suppliers/Bureau%20of%20Meteorology
Sample responses
JSON

{
"data": {
    "name":"Bureau of Meteorology",
}
}
    
CSV

"name"
"Bureau of Meteorology"
    

NOTE: when constructing the URL, spaces in the supplier's name must be replaced by "%20"

Back to top