Urban Observatory Radar API

For downloading data from Urban Observatory Radar

# Install the Python client library
$ pip install coreapi

png

list

GET /png/

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`limit`	Number of results to return per page.
`offset`	The initial index from which to return the results.
`angle`
`range`
`starttime`
`endtime`
`ordering`

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.radar.urbanobservatory.ac.uk/")

# Interact with the API endpoint
action = ["png", "list"]
params = {
    "limit": ...,
    "offset": ...,
    "angle": ...,
    "range": ...,
    "starttime": ...,
    "endtime": ...,
    "ordering": ...,
}
result = client.action(schema, action, params=params)

datafile

GET /png/file/{file_name}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`file_name` required

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.radar.urbanobservatory.ac.uk/")

# Interact with the API endpoint
action = ["png", "datafile"]
params = {
    "file_name": ...,
}
result = client.action(schema, action, params=params)

by_name

GET /png/name/{file_name}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`file_name` required

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.radar.urbanobservatory.ac.uk/")

# Interact with the API endpoint
action = ["png", "by_name"]
params = {
    "file_name": ...,
}
result = client.action(schema, action, params=params)

read

GET /png/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this radar png.

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`angle`
`range`
`starttime`
`endtime`
`ordering`

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.radar.urbanobservatory.ac.uk/")

# Interact with the API endpoint
action = ["png", "read"]
params = {
    "id": ...,
    "angle": ...,
    "range": ...,
    "starttime": ...,
    "endtime": ...,
    "ordering": ...,
}
result = client.action(schema, action, params=params)

raw

list

GET /raw/

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`limit`	Number of results to return per page.
`offset`	The initial index from which to return the results.
`angle`
`range`
`starttime`
`endtime`
`order`

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.radar.urbanobservatory.ac.uk/")

# Interact with the API endpoint
action = ["raw", "list"]
params = {
    "limit": ...,
    "offset": ...,
    "angle": ...,
    "range": ...,
    "starttime": ...,
    "endtime": ...,
    "order": ...,
}
result = client.action(schema, action, params=params)

datafile

GET /raw/file/{file_name}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`file_name` required

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.radar.urbanobservatory.ac.uk/")

# Interact with the API endpoint
action = ["raw", "datafile"]
params = {
    "file_name": ...,
}
result = client.action(schema, action, params=params)

by_name

GET /raw/name/{file_name}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`file_name` required

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.radar.urbanobservatory.ac.uk/")

# Interact with the API endpoint
action = ["raw", "by_name"]
params = {
    "file_name": ...,
}
result = client.action(schema, action, params=params)

read

GET /raw/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this raw radar file.

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`angle`
`range`
`starttime`
`endtime`
`order`

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.radar.urbanobservatory.ac.uk/")

# Interact with the API endpoint
action = ["raw", "read"]
params = {
    "id": ...,
    "angle": ...,
    "range": ...,
    "starttime": ...,
    "endtime": ...,
    "order": ...,
}
result = client.action(schema, action, params=params)

stats

list

GET /stats/

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`limit`	Number of results to return per page.
`offset`	The initial index from which to return the results.
`angle`
`range`
`starttime`
`endtime`
`order`

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.radar.urbanobservatory.ac.uk/")

# Interact with the API endpoint
action = ["stats", "list"]
params = {
    "limit": ...,
    "offset": ...,
    "angle": ...,
    "range": ...,
    "starttime": ...,
    "endtime": ...,
    "order": ...,
}
result = client.action(schema, action, params=params)

by_name

GET /stats/name/{file_name}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`file_name` required

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.radar.urbanobservatory.ac.uk/")

# Interact with the API endpoint
action = ["stats", "by_name"]
params = {
    "file_name": ...,
}
result = client.action(schema, action, params=params)

read

GET /stats/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this radar scan stats.

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`angle`
`range`
`starttime`
`endtime`
`order`

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.radar.urbanobservatory.ac.uk/")

# Interact with the API endpoint
action = ["stats", "read"]
params = {
    "id": ...,
    "angle": ...,
    "range": ...,
    "starttime": ...,
    "endtime": ...,
    "order": ...,
}
result = client.action(schema, action, params=params)

tiff

list

GET /tiff/

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`limit`	Number of results to return per page.
`offset`	The initial index from which to return the results.
`angle`
`range`
`starttime`
`endtime`
`order`

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.radar.urbanobservatory.ac.uk/")

# Interact with the API endpoint
action = ["tiff", "list"]
params = {
    "limit": ...,
    "offset": ...,
    "angle": ...,
    "range": ...,
    "starttime": ...,
    "endtime": ...,
    "order": ...,
}
result = client.action(schema, action, params=params)

datafile

GET /tiff/file/{file_name}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`file_name` required

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.radar.urbanobservatory.ac.uk/")

# Interact with the API endpoint
action = ["tiff", "datafile"]
params = {
    "file_name": ...,
}
result = client.action(schema, action, params=params)

by_name

GET /tiff/name/{file_name}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`file_name` required

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.radar.urbanobservatory.ac.uk/")

# Interact with the API endpoint
action = ["tiff", "by_name"]
params = {
    "file_name": ...,
}
result = client.action(schema, action, params=params)

read

GET /tiff/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this radar tiff.

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`angle`
`range`
`starttime`
`endtime`
`order`

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.radar.urbanobservatory.ac.uk/")

# Interact with the API endpoint
action = ["tiff", "read"]
params = {
    "id": ...,
    "angle": ...,
    "range": ...,
    "starttime": ...,
    "endtime": ...,
    "order": ...,
}
result = client.action(schema, action, params=params)

video

GET /video/

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`limit`	Number of results to return per page.
`offset`	The initial index from which to return the results.

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.radar.urbanobservatory.ac.uk/")

# Interact with the API endpoint
action = ["video", "list"]
params = {
    "limit": ...,
    "offset": ...,
}
result = client.action(schema, action, params=params)

datafile

GET /video/file/{file_name}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`file_name` required

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.radar.urbanobservatory.ac.uk/")

# Interact with the API endpoint
action = ["video", "datafile"]
params = {
    "file_name": ...,
}
result = client.action(schema, action, params=params)

by_name

GET /video/name/{file_name}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`file_name` required

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.radar.urbanobservatory.ac.uk/")

# Interact with the API endpoint
action = ["video", "by_name"]
params = {
    "file_name": ...,
}
result = client.action(schema, action, params=params)

read

GET /video/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this radar video.

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.radar.urbanobservatory.ac.uk/")

# Interact with the API endpoint
action = ["video", "read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

zip

raw > list

GET /zip/raw/

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`limit`	Number of results to return per page.
`offset`	The initial index from which to return the results.

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.radar.urbanobservatory.ac.uk/")

# Interact with the API endpoint
action = ["zip", "raw > list"]
params = {
    "limit": ...,
    "offset": ...,
}
result = client.action(schema, action, params=params)

raw > datafile

GET /zip/raw/file/{file_name}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`file_name` required

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.radar.urbanobservatory.ac.uk/")

# Interact with the API endpoint
action = ["zip", "raw > datafile"]
params = {
    "file_name": ...,
}
result = client.action(schema, action, params=params)

raw > by_name

GET /zip/raw/name/{file_name}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`file_name` required

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.radar.urbanobservatory.ac.uk/")

# Interact with the API endpoint
action = ["zip", "raw > by_name"]
params = {
    "file_name": ...,
}
result = client.action(schema, action, params=params)

raw > read

GET /zip/raw/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this raw data zip file.

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.radar.urbanobservatory.ac.uk/")

# Interact with the API endpoint
action = ["zip", "raw > read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

tiff > list

GET /zip/tiff/

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`limit`	Number of results to return per page.
`offset`	The initial index from which to return the results.

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.radar.urbanobservatory.ac.uk/")

# Interact with the API endpoint
action = ["zip", "tiff > list"]
params = {
    "limit": ...,
    "offset": ...,
}
result = client.action(schema, action, params=params)

tiff > datafile

GET /zip/tiff/file/{file_name}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`file_name` required

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.radar.urbanobservatory.ac.uk/")

# Interact with the API endpoint
action = ["zip", "tiff > datafile"]
params = {
    "file_name": ...,
}
result = client.action(schema, action, params=params)

tiff > by_name

GET /zip/tiff/name/{file_name}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`file_name` required

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.radar.urbanobservatory.ac.uk/")

# Interact with the API endpoint
action = ["zip", "tiff > by_name"]
params = {
    "file_name": ...,
}
result = client.action(schema, action, params=params)

tiff > read

GET /zip/tiff/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this tiff data zip file.

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.radar.urbanobservatory.ac.uk/")

# Interact with the API endpoint
action = ["zip", "tiff > read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)