UK Tidal API - Discovery

API change history

The ADMIRALTY UK Tidal API provides authoritative source of tidal height predictions for Standard and Secondary tidal level stations around the United Kingdom. Discovery provides a free 1-year subscription to access the current plus 6 days’ worth of tidal events for 607 tidal stations around the United Kingdom.

TidalEvents

Returns high and low water events for the specified Tidal Station.

Try it

Request

Request URL

Request parameters

  • string

    The Station ID.

  • (optional)
    integer

    Format - int32. The number of days for which the tidal events will be returned. If this parameter is omitted, a default value of 7 is used which represents today plus the next six days. Valid range is 1 to 7 inclusive. Any other values will return a bad request

Request headers

  • string
    Subscription key which provides access to this API. Found in your Profile.

Request body

Responses

200 OK

OK: A list of Tidal Events is returned in the response body.

Representations

[
  {
    "EventType": "HighWater",
    "DateTime": "string",
    "Height": 0.0,
    "IsApproximateTime": true,
    "IsApproximateHeight": true,
    "Filtered": true
  }
]
{
  "type": "array",
  "items": {
    "description": "A representation of a tide time.",
    "required": [
      "EventType"
    ],
    "type": "object",
    "properties": {
      "EventType": {
        "description": "Whether the event is for a high or low tide.",
        "enum": [
          "HighWater",
          "LowWater"
        ],
        "type": "string",
        "readOnly": true
      },
      "DateTime": {
        "format": "date-time",
        "description": "The time of the tidal event. This may be missing if it is invalid",
        "type": "string",
        "readOnly": true
      },
      "Height": {
        "format": "double",
        "description": "Tidal height in metres. This may be missing if it is invalid",
        "type": "number",
        "readOnly": true
      },
      "IsApproximateTime": {
        "description": "If the time is approximate.",
        "type": "boolean",
        "readOnly": true
      },
      "IsApproximateHeight": {
        "description": "If the height is approximate.",
        "type": "boolean",
        "readOnly": true
      },
      "Filtered": {
        "description": "When set, this indicates that the tidal events either side of this tidal event have been removed.",
        "type": "boolean",
        "readOnly": true
      }
    }
  }
}
[
  {
    "EventType": "HighWater",
    "DateTime": "string",
    "Height": 0.0,
    "IsApproximateTime": true,
    "IsApproximateHeight": true,
    "Filtered": true
  }
]
{
  "type": "array",
  "items": {
    "description": "A representation of a tide time.",
    "required": [
      "EventType"
    ],
    "type": "object",
    "properties": {
      "EventType": {
        "description": "Whether the event is for a high or low tide.",
        "enum": [
          "HighWater",
          "LowWater"
        ],
        "type": "string",
        "readOnly": true
      },
      "DateTime": {
        "format": "date-time",
        "description": "The time of the tidal event. This may be missing if it is invalid",
        "type": "string",
        "readOnly": true
      },
      "Height": {
        "format": "double",
        "description": "Tidal height in metres. This may be missing if it is invalid",
        "type": "number",
        "readOnly": true
      },
      "IsApproximateTime": {
        "description": "If the time is approximate.",
        "type": "boolean",
        "readOnly": true
      },
      "IsApproximateHeight": {
        "description": "If the height is approximate.",
        "type": "boolean",
        "readOnly": true
      },
      "Filtered": {
        "description": "When set, this indicates that the tidal events either side of this tidal event have been removed.",
        "type": "boolean",
        "readOnly": true
      }
    }
  }
}
<UKHO.TidalPrediction.Api.Models.ITidalEventArray>
  <EventType>HighWater</EventType>
  <DateTime>string</DateTime>
  <Height>0</Height>
  <IsApproximateTime>true</IsApproximateTime>
  <IsApproximateHeight>true</IsApproximateHeight>
  <Filtered>true</Filtered>
</UKHO.TidalPrediction.Api.Models.ITidalEventArray>
{
  "type": "array",
  "items": {
    "description": "A representation of a tide time.",
    "required": [
      "EventType"
    ],
    "type": "object",
    "properties": {
      "EventType": {
        "description": "Whether the event is for a high or low tide.",
        "enum": [
          "HighWater",
          "LowWater"
        ],
        "type": "string",
        "readOnly": true
      },
      "DateTime": {
        "format": "date-time",
        "description": "The time of the tidal event. This may be missing if it is invalid",
        "type": "string",
        "readOnly": true
      },
      "Height": {
        "format": "double",
        "description": "Tidal height in metres. This may be missing if it is invalid",
        "type": "number",
        "readOnly": true
      },
      "IsApproximateTime": {
        "description": "If the time is approximate.",
        "type": "boolean",
        "readOnly": true
      },
      "IsApproximateHeight": {
        "description": "If the height is approximate.",
        "type": "boolean",
        "readOnly": true
      },
      "Filtered": {
        "description": "When set, this indicates that the tidal events either side of this tidal event have been removed.",
        "type": "boolean",
        "readOnly": true
      }
    }
  }
}
<UKHO.TidalPrediction.Api.Models.ITidalEventArray>
  <EventType>HighWater</EventType>
  <DateTime>string</DateTime>
  <Height>0</Height>
  <IsApproximateTime>true</IsApproximateTime>
  <IsApproximateHeight>true</IsApproximateHeight>
  <Filtered>true</Filtered>
</UKHO.TidalPrediction.Api.Models.ITidalEventArray>
{
  "type": "array",
  "items": {
    "description": "A representation of a tide time.",
    "required": [
      "EventType"
    ],
    "type": "object",
    "properties": {
      "EventType": {
        "description": "Whether the event is for a high or low tide.",
        "enum": [
          "HighWater",
          "LowWater"
        ],
        "type": "string",
        "readOnly": true
      },
      "DateTime": {
        "format": "date-time",
        "description": "The time of the tidal event. This may be missing if it is invalid",
        "type": "string",
        "readOnly": true
      },
      "Height": {
        "format": "double",
        "description": "Tidal height in metres. This may be missing if it is invalid",
        "type": "number",
        "readOnly": true
      },
      "IsApproximateTime": {
        "description": "If the time is approximate.",
        "type": "boolean",
        "readOnly": true
      },
      "IsApproximateHeight": {
        "description": "If the height is approximate.",
        "type": "boolean",
        "readOnly": true
      },
      "Filtered": {
        "description": "When set, this indicates that the tidal events either side of this tidal event have been removed.",
        "type": "boolean",
        "readOnly": true
      }
    }
  }
}

400 Bad Request

Bad Request: The stationId parameter is malformed or not present, or the duration parameter is outside of accepted range

401 Unauthorized

Unauthorised user or incorrect subscription key

403 Forbidden

Quota Exceeded

404 Not Found

Not Found: The requested Station ID could not be found.

429 Too many requests

Too Many Requests

500 Internal Server Error

Internal Server Error

Code samples

@ECHO OFF

curl -v -X GET "https://admiraltyapi.azure-api.net/uktidalapi/api/V1/Stations/{stationId}/TidalEvents?duration={integer}"
-H "Ocp-Apim-Subscription-Key: {subscription key}"

--data-ascii "{body}" 
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");

            // Request parameters
            queryString["duration"] = "{integer}";
            var uri = "https://admiraltyapi.azure-api.net/uktidalapi/api/V1/Stations/{stationId}/TidalEvents?" + queryString;

            var response = await client.GetAsync(uri);
        }
    }
}	
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://admiraltyapi.azure-api.net/uktidalapi/api/V1/Stations/{stationId}/TidalEvents");

            builder.setParameter("duration", "{integer}");

            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);
            request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}

<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
            "duration": "{integer}",
        };
      
        $.ajax({
            url: "https://admiraltyapi.azure-api.net/uktidalapi/api/V1/Stations/{stationId}/TidalEvents?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "GET",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>
#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://admiraltyapi.azure-api.net/uktidalapi/api/V1/Stations/{stationId}/TidalEvents";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"duration={integer}",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"GET"];
    // Request headers
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://admiraltyapi.azure-api.net/uktidalapi/api/V1/Stations/{stationId}/TidalEvents');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'duration' => '{integer}',
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_GET);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
    # Request parameters
    'duration': '{integer}',
})

try:
    conn = httplib.HTTPSConnection('admiraltyapi.azure-api.net')
    conn.request("GET", "/uktidalapi/api/V1/Stations/{stationId}/TidalEvents?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
    # Request parameters
    'duration': '{integer}',
})

try:
    conn = http.client.HTTPSConnection('admiraltyapi.azure-api.net')
    conn.request("GET", "/uktidalapi/api/V1/Stations/{stationId}/TidalEvents?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
require 'net/http'

uri = URI('https://admiraltyapi.azure-api.net/uktidalapi/api/V1/Stations/{stationId}/TidalEvents')

query = URI.encode_www_form({
    # Request parameters
    'duration' => '{integer}'
})
if query.length > 0
  if uri.query && uri.query.length > 0
    uri.query += '&' + query
  else
    uri.query = query
  end
end

request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body