LogoLogo
OS Docs HomeOS NGDOS APIsOS Download ProductsMore than MapsOS Data Hub
  • Introduction to OS APIs
  • Core Concepts
    • Getting started with an API project
    • Authentication
    • Error codes
    • Rate-limiting policy
    • OS API branding
    • Service level agreements
    • Service availability dashboard
  • Accessing OS APIs
    • OS Maps API
      • Layers and styles
      • Getting started
        • ESRI ArcGIS Online
        • ESRI ArcGIS Pro
        • ESRI ArcMap
        • Cadcorp SIS
        • MapInfo Pro
        • QGIS
      • Technical specification
        • ZXY
        • WMTS
      • Code examples
    • OS Vector Tile API
      • What data is available?
      • Getting started
        • ESRI ArcGIS Pro
        • Cadcorp SIS
        • QGIS
        • Create a web application using the OS Vector Tile API
      • Technical specification
        • Service Metadata
        • Stylesheet
        • Tile request
      • Code examples
      • Stylesheets
    • OS NGD API – Tiles
    • OS NGD API – Features
    • OS Features API
      • OS Product Archive
      • What data is available?
      • Getting started
        • ArcGIS Online
        • ArcGIS Pro
        • ArcMap
        • Cadcorp SIS
        • MapInfo Pro
        • QGIS
      • Technical specification
        • getCapabilities
        • describeFeatureType
        • getFeature
        • Filtering
        • Paging
        • Empty values
      • Code examples
    • OS Names API
      • Getting started with example queries using Node.js
      • Technical specification
        • Find
        • Nearest
      • Code list
      • Code examples
    • OS Linked Identifiers API
      • What data is available?
      • Getting started with implementing a look-up application
      • Technical specification
        • Identifier
        • Identifier Types
        • Feature Types
        • Product Version Information
      • Code examples
    • OS Places API
      • Getting started with example queries using Node.js
      • Technical specification
        • Find
        • Postcode
        • UPRN
        • Nearest
        • BBOX
        • Radius
        • Polygon
      • Datasets
      • Code lists
      • Code examples
    • OS Match & Cleanse API
      • End of Life Information
      • Getting started with an example match query using Node.js
      • Technical specification
      • Datasets
      • Code lists
    • OS Downloads API
      • Getting started
        • Automating OS OpenData downloads
        • Automating OS Premium data downloads
      • Technical specification
        • OpenData products
        • OpenData product details
        • Download an OpenData product
        • OpenData product image
        • Data packages
        • Data package ID
        • Data package version
        • Data package version ID
        • Download a data package
    • 🆕OS Net API
      • 🆕Getting started
      • 🆕Technical specification
        • Stations
        • Rinex
        • Models
    • OAuth 2 API
      • Getting started
      • Technical specification
  • Additional resources
    • OS API Wrappers
      • JavaScript
      • Python
      • R
  • Extra Links
    • Accessibility
    • Contact us
    • PSGA Product Summary
    • Terms and conditions
Powered by GitBook
On this page
  1. Accessing OS APIs
  2. 🆕OS Net API
  3. 🆕Technical specification

Stations

PreviousTechnical specificationNextRinex

Was this helpful?

CtrlK
  • GET/stations
  • GET/stations/health
  • GET/stations/{stationId}
  • GET/stations/{stationId}/health
  • GET/stations/{stationId}/log

Was this helpful?

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
Query parameters
Responses
200

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

400

Bad request

application/problem+json
get
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
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
get
GET /positioning/osnet/v1/stations/health 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
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

400

Bad request

application/problem+json
404

Not Found

application/problem+json
get
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
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
get
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
Path parameters
stationIdstring · min: 4 · max: 4Required

Specific station ID.

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

Returns the station logs

Responsestring
400

Bad request

application/problem+json
404

Not Found

application/problem+json
get
GET /positioning/osnet/v1/stations/{stationId}/log HTTP/1.1
Host: api.os.uk
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
text