Stations | OS APIs

get

Get a list of the current GPS stations over the specified time period. The info is derived from https://www.ordnancesurvey.co.uk/documents/resources/osnet-coordinates-file.txt. Note that if the start and end date are omitted then the response will not contain the percentageComplete property.

Authorizations

OAuth2clientCredentialsRequired

Token URL:

Query parameters

Responses

200

Returns the list of stations, either as structured JSON data or a simple text file

Information about a GPS station.

stationIdstringRequiredExample: ABEP

stationNamestringOptionalExample: Aberporth

ETRS89_XnumberRequiredExample: 3910361.3337

ETRS89_YnumberRequiredExample: -312649.7649

ETRS89_ZnumberRequiredExample: 5012487.9118

ETRS89_LatstringRequiredExample: N 52 08 21.903992

ETRS89_LongstringRequiredExample: W 004 34 16.727173

ETRS89_HnumberRequiredExample: 188.467

OSGB36_EnumberRequiredExample: 224134.523

OSGB36_NnumberRequiredExample: 252130.77

ortho_hnumberRequiredExample: 134.238

ortho_DatumstringRequiredExample: Ordnance Datum Newlyn

tranModelstringRequiredExample: 15

percentageCompleteinteger · max: 100Required

Health percentage, based on expected and actual data for the station, and for the overall time period that was queried. If the time period is omitted then the percentage complete will not be included in the response.

distancenumberOptional

Distance in KM from given search point, to two decimal places. Omitted if the query did not include a location.

Example: 12.34

400

Bad request

application/problem+json

get

/stations

GET /positioning/osnet/v1/stations HTTP/1.1
Host: api.os.uk
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "stationId": "ABEP",
    "stationName": "Aberporth",
    "ETRS89_X": 3910361.3337,
    "ETRS89_Y": -312649.7649,
    "ETRS89_Z": 5012487.9118,
    "ETRS89_Lat": "N 52 08 21.903992",
    "ETRS89_Long": "W 004 34 16.727173",
    "ETRS89_H": 188.467,
    "OSGB36_E": 224134.523,
    "OSGB36_N": 252130.77,
    "ortho_h": 134.238,
    "ortho_Datum": "Ordnance Datum Newlyn",
    "tranModel": 15,
    "percentageComplete": 1,
    "distance": 12.34,
    "links": [
      {
        "href": "https://api.os.uk/positioning/osnet/v1/stations/ABEP",
        "rel": "self",
        "type": "application/json",
        "title": "Self link",
        "description": "This station"
      },
      {
        "href": "https://api.os.uk/positioning/osnet/v1/stations/ABEP/rinex",
        "rel": "service-endpoint",
        "type": "application/json",
        "title": "Station data",
        "description": "List the data available for this station"
      },
      {
        "href": "https://api.os.uk/positioning/osnet/v1/stations/ABEP/log",
        "rel": "service-endpoint",
        "type": "application/text",
        "title": "Station log",
        "description": "Link to the station log"
      }
    ]
  }
]

get

Get an hour-by-hour breakdown of the OS Net network health for a specific date.

Authorizations

OAuth2clientCredentialsRequired

Token URL:

Query parameters

datestring · dateRequired

Date for the network health search. Please note that the date should be within the last 45 days.

Example: 2024-11-30

Responses

200

Returns the network health for the given date. Each station in the network will be included in the response.

application/json

stationIdstringOptionalExample: ABEP

get

/stations/health

GET /positioning/osnet/v1/stations/health?date=2024-11-30 HTTP/1.1
Host: api.os.uk
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

200

Returns the network health for the given date. Each station in the network will be included in the response.

[
  {
    "stationId": "ABEP",
    "hourlyData": [
      {
        "hour": 1,
        "percentageComplete": 1
      }
    ]
  }
]

get

Get info on specified station over a specified time period. Note that if the start and end date are omitted then the response will not contain the percentageComplete property.

Authorizations

OAuth2clientCredentialsRequired

Token URL:

Path parameters

stationIdstring · min: 4 · max: 4Required

Specific station ID.

Example: ABEPPattern: ^[a-zA-Z0-9]*$

Query parameters

Responses

200

Returns info about the station, as structured JSON data

Information about a GPS station.

stationIdstringRequiredExample: ABEP

stationNamestringOptionalExample: Aberporth

ETRS89_XnumberRequiredExample: 3910361.3337

ETRS89_YnumberRequiredExample: -312649.7649

ETRS89_ZnumberRequiredExample: 5012487.9118

ETRS89_LatstringRequiredExample: N 52 08 21.903992

ETRS89_LongstringRequiredExample: W 004 34 16.727173

ETRS89_HnumberRequiredExample: 188.467

OSGB36_EnumberRequiredExample: 224134.523

OSGB36_NnumberRequiredExample: 252130.77

ortho_hnumberRequiredExample: 134.238

ortho_DatumstringRequiredExample: Ordnance Datum Newlyn

tranModelstringRequiredExample: 15

percentageCompleteinteger · max: 100Required

Health percentage, based on expected and actual data for the station, and for the overall time period that was queried. If the time period is omitted then the percentage complete will not be included in the response.

distancenumberOptional

Distance in KM from given search point, to two decimal places. Omitted if the query did not include a location.

Example: 12.34

400

Bad request

application/problem+json

404

Not Found

application/problem+json

get

/stations/{stationId}

GET /positioning/osnet/v1/stations/{stationId} HTTP/1.1
Host: api.os.uk
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "stationId": "ABEP",
  "stationName": "Aberporth",
  "ETRS89_X": 3910361.3337,
  "ETRS89_Y": -312649.7649,
  "ETRS89_Z": 5012487.9118,
  "ETRS89_Lat": "N 52 08 21.903992",
  "ETRS89_Long": "W 004 34 16.727173",
  "ETRS89_H": 188.467,
  "OSGB36_E": 224134.523,
  "OSGB36_N": 252130.77,
  "ortho_h": 134.238,
  "ortho_Datum": "Ordnance Datum Newlyn",
  "tranModel": 15,
  "percentageComplete": 1,
  "distance": 12.34,
  "links": [
    {
      "href": "https://api.os.uk/positioning/osnet/v1/stations/ABEP",
      "rel": "self",
      "type": "application/json",
      "title": "Self link",
      "description": "This station"
    },
    {
      "href": "https://api.os.uk/positioning/osnet/v1/stations/ABEP/rinex",
      "rel": "service-endpoint",
      "type": "application/json",
      "title": "Station data",
      "description": "List the data available for this station"
    },
    {
      "href": "https://api.os.uk/positioning/osnet/v1/stations/ABEP/log",
      "rel": "service-endpoint",
      "type": "application/text",
      "title": "Station log",
      "description": "Link to the station log"
    }
  ]
}

get

Get health information about a specific station

Authorizations

OAuth2clientCredentialsRequired

Token URL:

Path parameters

stationIdstring · min: 4 · max: 4Required

Specific station ID.

Example: ABEPPattern: ^[a-zA-Z0-9]*$

Responses

200

Returns the station health, on a day-by-day basis

application/json

datestring · dateOptionalExample: 2024-11-30

get

/stations/{stationId}/health

GET /positioning/osnet/v1/stations/{stationId}/health HTTP/1.1
Host: api.os.uk
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

200

Returns the station health, on a day-by-day basis

[
  {
    "date": "2024-11-30",
    "hourlyData": [
      {
        "hour": 1,
        "percentageComplete": 1
      }
    ]
  }
]

get

Get logs for specified station

Authorizations

OAuth2clientCredentialsRequired

Token URL:

Path parameters

stationIdstring · min: 4 · max: 4Required

Specific station ID.

Example: ABEPPattern: ^[a-zA-Z0-9]*$

Responses

200

Returns the station logs

stringOptional

400

Bad request

application/problem+json

404

Not Found

application/problem+json

get

/stations/{stationId}/log

GET /positioning/osnet/v1/stations/{stationId}/log HTTP/1.1
Host: api.os.uk
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

text