Tide

Platform: API iOS Android

Global tidal data for the next 10 days, including tide table and hourly tide forecast data.

Interface code Interface Class
oceanTide Tide data OceanTideResponse

Parameters

OceanParameter

  • location(required)The tide station to be queried, need LocationID and LocationID can be obtained by POI Lookup. For example: location=P2951
  • date(required)Set the date, up to 10 days in the future (including today). The date format is yyyyMMdd. Eexample: date=20200531

Sample code

Swift

Task{
    do {
        let sevenDaysAfter = Calendar.current.date(byAdding: .day, value: 7, to: Date())!
        let formatter = DateFormatter()
        formatter.dateFormat = "yyyMMdd"
        let date = formatter.string(from: sevenDaysAfter)
        let parameter = OceanParameter(location: "P2236", date: date)
        let response = try await QWeather.instance
            .oceanTide(parameter)
        print(response)
    } catch QWeatherError.errorResponse(let error) {
        print(error)
    } catch {
        print(error)
    }
}

Objective-C

NSDate * sevenDaysAfter = [[NSCalendar currentCalendar] dateByAddingUnit:NSCalendarUnitDay value:7 toDate:[NSDate date] options:0];
NSDateFormatter * formatter = [[NSDateFormatter alloc] init];
[formatter setDateFormat:@"yyyyMMdd"];
NSString * date = [formatter stringFromDate:sevenDaysAfter];
OceanParameter *parameter = [OceanParameter instanceWithLocation:@"P2236" date:date];
[QWeatherObjc oceanTide:parameter completionHandler:^(OceanTideResponse * _Nullable response, NSError * _Nullable error) {
    if (response) {
        NSLog(@"%@", response.description);
    }
    if (error) {
        NSLog(@"%@", error.localizedDescription);
    }
}];

Response

OceanTideResponse

  • code See Status Code
  • updateTime API last update time
  • fxLink Responsive web page of this data, for embedded in website or APP
  • tideTable.fxTime High tide or Low tide time
  • tideTable.height The height of the wave, in meters
  • tideTable.type High tide (H) or Low tide (L)
  • tideHourly.fxTime Hourly forecast time
  • tideHourly.height The height of the wave, in meters, maybe null for some POI
  • refer.sources Data source and other statements, may be null
  • refer.license Data license, may be null