iwls_api_request.api package

Subpackages

iwls_api_request.api.endpoint package

Submodules

iwls_api_request.api.datetime_utils module

iwls_api_request.api.datetime_utils.get_datetime_from_iso8601(date)[source]

Return type:: datetime

iwls_api_request.api.datetime_utils.get_iso8601_from_datetime(date)[source]

Return type:: str

iwls_api_request.api.datetime_utils.split_time(from_time, to_time, time_delta=datetime.timedelta(days=7))[source]

Return type:: Generator[tuple[str, str], None, None]

iwls_api_request.api.exceptions_iwls module

exception iwls_api_request.api.exceptions_iwls.CoordinatesError[source]: Bases: Exception

exception iwls_api_request.api.exceptions_iwls.StationsError[source]: Bases: Exception

iwls_api_request.api.ids_iwls module

iwls_api_request.api.iwls_api_abc module

class iwls_api_request.api.iwls_api_abc.IWLSapiABC(query_handler, endpoint)[source]

Bases: ABC

static _aggregate_data(futures, time_serie_code, station)[source]

Méthode permettant d’agréger les données de plusieurs requêtes.

Parameters:

futures (Collection) – (Collection) Une liste de futures contenant les données.
time_serie_code (str) – (str) Le code de la série temporelle.
station (str) – (str) L’identifiant de la station.

Return type:

tuple[list[dict], list[str]]

Returns:

(tuple) Une liste de données agrégées et une liste d’erreurs.

static _validate_coordinates(latitude, longitude)[source]

Méthode permettant de valider la latitude et la longitude.

Parameters:

latitude (float | int) – (Union[float, int]) La latitude de la station.
longitude (float | int) – (Union[float, int]) La longitude de la station.

Return type:

tuple[float | int, float | int]

Returns:

(Tuple[Union[float, int], Union[float, int]]) La latitude et la longitude validées.

Raise:

TypeError si les coordonnées sont du mauvais type.

Raise:

CoordinatesError si les coordonnées sont invalides.

static _validate_iso_date(date)[source]

Méthode permettant de valider le format de la date.

Parameters:: date (str) – (str) La date en format ISO 8601 UTC (ex: 2021-02-13T19:18:00Z).
Return type:: str
Returns:: (str) La date si est elle valide.
Raise:: ValueError si la date est invalide.

_construct_url(endpoint, **kwargs)[source]

Méthode permettant de construire l’url de la requête.

Parameters:: endpoint (str) – (str) Un point d’entré pour la requête.
Return type:: str
Returns:: (str) L’url de la requête.

_fetch_and_aggregate_data(function, interval, time_serie_code, station, datetime_sorted=True)[source]

Méthode permettant de récupérer et d’agréger les données de plusieurs requêtes.

Parameters:

function (Callable) – (Callable) La fonction à exécuter.
interval (Generator[tuple[str, str], None, None]) – (Generator) Un générateur contenant les intervalles de temps.
time_serie_code (str) – (str) Le code de la série temporelle.
station (str) – (str) L’identifiant de la station.
datetime_sorted (bool) – (bool) Si les données doivent être triées par date.

Return type:

Response

Returns:

(Response) Un objet Response contenant les données agrégées.

_validate_query_parameters(**kwargs)[source]

Méthode permettant de valider les paramètres de la requête.

Return type:: dict[str, str]
Returns:: (dict[str, str]) Un dictionnaire contenant les paramètres valides.

_validate_station_id(station_id)[source]

Méthode permettant de valider l’identifiant d’une station’.

Parameters:: station_id (str) – (str) L’identifiant d’une station.
Return type:: str
Returns:: (str) L’identifiant si il est valide.
Raise:: ValueError si l’identifiant est invalide.

abstractmethod get_all_stations(code=None, chs_region_code=None, time_serie_code=None)[source]

Méthode permettant de récupérer une liste de stations ainsi que les informations les concernant.

Parameters:

code (Optional[str]) – (str) Le code d’une station. Écrase les autres paramètres.
chs_region_code (Optional[Regions]) – (Regions) Le code d’une région (PAC, CNA, ATL, QUE).
time_serie_code (Optional[TimeSeries]) – (TimeSeries) Le code de la série temporelle désirée. wlo : Official quality controlled water level observation wlp: Water level prediction for the next years wlp-hilo: Tide tables prediction for the next years wlp-bores : Bores arrival and intensity wcp-slack : Reversing falls wlf : Water level forecast for the next 48 hours wlf-spine dvcf-spine : Dynamic vertical clearance forecast under infrastructure like bridges

Return type:

Response

Returns:

(Response) Un objet Response contenant les stations ainsi que les informations les concernant.

abstractmethod get_benchmark(benchmark_id)[source]

Méthode permettant de récupérer un repère.

Parameters:: benchmark_id (str) – (str) L’identifiant du repère.
Return type:: Response
Returns:: (Response) Un objet Response contenant les informations sur le repère.

abstractmethod get_benchmark_metadata(benchmark_id)[source]

Méthode permettant de récupérer les métadonnées d’un repère.

Parameters:: benchmark_id (str) – (str) L’identifiant du repère.
Return type:: Response
Returns:: (Response) Un objet Response contenant les métadonnées sur le repère.

abstractmethod get_benchmarks(station_ids=None, **kwargs)[source]

Méthode permettant de récupérer les repères des stations.

Parameters:: station_ids (Collection[str]) – (Collection[str]) Une liste contenant les identifiants des stations.
Return type:: Response
Returns:: (Response) Un objet Response contenant les informations sur les repères.

get_closest_station(stations_list, latitude, longitude)[source]

Méthode permettant de récupérer la station la plus près des coordonnées géographiques.

Parameters:

stations_list (Collection[dict]) – (Collection[dict]) Une liste des stations.
latitude (float | int) – (Union[float, int]) La latitude en format degré décimal.
longitude (float | int) – (Union[float, int]) La longitude en format degré décimal.

Return type:

dict[str, Any]

Returns:

(dict[str, Any]) Les informations de la station la plus près des coordonnées géographiques.

abstractmethod get_elevations(benchmark_id)[source]

Méthode permettant de récupérer les métadonnées d’un repère.

Parameters:: benchmark_id (str) – (str) L’identifiant du repère.
Return type:: Response
Returns:: (Response) Un objet Response contenant les métadonnées sur le repère.

get_elevations_for_benchmarks(benchmarks_ids=None)[source]

Méthode permettant de récupérer les élévations concernant une liste de repères.

Parameters:: benchmarks_ids (Sequence[str]) – (Sequence[str]) Une liste contenant les benchmarks.
Return type:: dict[str, Response]
Returns:: (dict[str, Response]) Un objet Response contenant les élévations des repères.

abstractmethod get_height(height)[source]

Méthode permettant de récupérer un type de hauteur.

Parameters:: height (str) – (str) L’identifiant de la hauteur.
Return type:: Response
Returns:: (Response) Un objet Response contenant les informations concernant ce type de hauteur.

abstractmethod get_height_types()[source]

Méthode permettant de récupérer les types de hauteur.

Return type:: Response
Returns:: (Response) Un objet Response contenant les différents types de hauteur.

abstractmethod get_info_station(station)[source]

Méthode permettant de récupérer les informations concernant une station.

Parameters:: station (str) – (str) L’identifiant de la station.
Return type:: Response
Returns:: (Response) Un objet Response contenant les informations de la station.

get_metadata_for_benchmarks(benchmarks_ids=None)[source]

Méthode permettant de récupérer les métadonnées concernant une liste de repères.

Parameters:: benchmarks_ids (Sequence[str]) – (Sequence[str]) Une liste contenant les benchmarks.
Return type:: dict[str, Response]
Returns:: (dict[str, Response]) Un objet Response contenant les métadonnées des repères.

abstractmethod get_metadata_station(station)[source]

Méthode permettant de récupérer les métadonnées concernant une station.

Parameters:: station (str) – (str) Le stationId de la station.
Return type:: Response
Returns:: (Response) Un objet Response contenant les métadonnées de la station.

get_metadata_stations(stations)[source]

Méthode permettant de récupérer les métadonnées concernant une liste de stations.

Parameters:: stations (Sequence[str]) – (Sequence[str]) Une liste contenant le stationId des station.
Return type:: dict[str, Response]
Returns:: (dict[str, Response]) Un objet Response contenant les métadonnées des stations.

abstractmethod get_phenomena()[source]

Méthode permettant de récupérer les phénomènes.

Return type:: Response
Returns:: (Response) Un objet Response contenant les différents phénomènes.

abstractmethod get_phenomenon(phenomenon)[source]

Méthode permettant de récupérer les informations d’un phénomène.

Return type:: Response
Returns:: (Response) Un objet Response contenant les informations concernant un phénomène.

abstractmethod get_station_daily_mean(station, from_time, to_time, **kwargs)[source]

Méthode permettant d’obtenir les moyennes journalières pour une station.

Parameters:

station (str) – (str) Le stationId de la station.
from_time (str) – (str) La date de début en format (ex: 2019-11-13).
to_time (str) – (str) La date de fin en format (ex: 2019-11-13).

Return type:

Response

Returns:

(Response) Un objet Response contenant les moyenne journalières de la station.

abstractmethod get_station_montly_mean(station, year, month, **kwargs)[source]

Méthode permettant d’obtenir la moyenne mensuelle pour une station.

Parameters:

station (str) – (str) Le stationId de la station.
year (str) – (str) L’année désirée.
month (str) – (str) Le mois désiré.

Return type:

Response

Returns:

(Response) La moyenne mensuelle de la station.

abstractmethod get_tide_table(tide_table)[source]

Méthode permettant de recupérer une table de marées.

Parameters:: tide_table (str) – (str) L’identifiant d’une table de marées.
Return type:: Response
Returns:: (Response) Un objet Response contenant les informations d’une table de marées.

abstractmethod get_tide_tables(type_table=None, parent_tide_table=None)[source]

Méthode permettant de recupérer la liste des tables de marées.

Parameters:

type_table (TypeTideTable) – (TypeTideTable) Un type de table. {VOLUME, AREA, SUB_AREA}
parent_tide_table (str) – (str) L’identifiant d’une table.

Return type:

Response

Returns:

(Response) Un objet Response contenant l’ensemble des tables de marées correspondant aux critères de la recherche.

get_time_serie_block_data(station, from_time, to_time, time_serie_code=TimeSeries.WLO, time_delta=datetime.timedelta(days=7), datetime_sorted=True, **kwargs)[source]

Méthode permttant de récupérer des données à partir de l’API de iWLS.

/api/v1/stations/{stationId}/data

Parameters:

station (str) – (str) Le stationId de la station.
time_serie_code (Optional[TimeSeries]) – (TimeSeries) Le code de la série temporelle désirée. wlo : Official quality controlled water level observation wlp: Water level prediction for the next years wlp-hilo: Tide tables prediction for the next years wlp-bores : Bores arrival and intensity wcp-slack : Reversing falls wlf : Water level forecast for the next 48 hours wlf-spine dvcf-spine : Dynamic vertical clearance forecast under infrastructure like bridges
from_time (str) – (str) La date de début en format ISO 8601 (ex: 2019-11-13T19:18:00Z).
to_time (str) – (str) La date de fin en format ISO 8601 (ex: 2019-11-13T19:18:00Z).
time_delta (timedelta) – (timedelta) L’intervalle de temps maximale pour chaque requête.
datetime_sorted (bool) – (bool) Si les données doivent être triées par date.

Return type:

Response

Returns:

(Response) Un objet Response contenant les données reçues de l’API de iWLS.

abstractmethod get_time_serie_data(station, from_time, to_time, time_serie_code=TimeSeries.WLO, **kwargs)[source]

Méthode permttant de récupérer des données à partir de l’API de iWLS.

Parameters:

station (str) – (str) Le stationId de la station.
time_serie_code (Optional[TimeSeries]) – (TimeSerie) Le code de la série temporelle désirée. wlo : Official quality controlled water level observation wlp: Water level prediction for the next years wlp-hilo: Tide tables prediction for the next years wlp-bores : Bores arrival and intensity wcp-slack : Reversing falls wlf : Water level forecast for the next 48 hours wlf-spine dvcf-spine : Dynamic vertical clearance forecast under infrastructure like bridges …
from_time (str) – (str) La date de début en format ISO 8601 (ex: 2019-11-13T19:18:00Z).
to_time (str) – (str) La date de fin en format ISO 8601 (ex: 2019-11-13T19:18:00Z).

Return type:

Response

Returns:

(Response) Un objet Response contenant les données de la série temporelle.

abstractmethod get_time_serie_definition(time_serie_definition_id)[source]

Méthode permettant de récupérer la définition d’une série temporelle.

Parameters:: time_serie_definition_id (str) – (str) L’identifiant de la série temporelle.
Return type:: Response
Returns:: (Response) Un objet Response contenant la définition de la série temporelle.

get_time_series_data(time_series, station, from_time, to_time, time_delta=datetime.timedelta(days=7), datetime_sorted=True)[source]

Méthode permettant de récupérer plusieurs série temporelle pour une station sur l’API de iWLS.

Parameters:

time_series (Sequence[TimeSeries]) – (Sequence[TimeSeries]) La liste des codes des times série.
station (str) – (str) Le code de la station.
from_time (str) – (str) La date de début en format ISO 8601 UTC (ex: 2021-02-13T19:18:00Z).
to_time (str) – (str) La date de fin en format ISO 8601 UTC (ex: 2021-02-13T19:18:00Z).
time_delta (timedelta) – (timedelta) L’intervalle de temps maximale pour chaque requête.
datetime_sorted (bool) – (bool) Si les données doivent être triées par date.

Return type:

dict[TimeSeries, Response]

Returns:

dict[TimeSeries, Response] Les résultats de la requête.

abstractmethod get_time_series_definitions(time_serie=None)[source]

Méthode permettant de récupérer les définitions des séries temporelles.

Parameters:: time_serie (Optional[TimeSeries]) – (TimeSeries) Le code de la série temporelle.
Return type:: Response
Returns:: (Response) Un objet Response contenant les définitions des séries temporelles.

_cache

_query_handler

property _stations: list

endpoint

property stations_dict: dict

property stations_list: list

iwls_api_request.api.iwls_public module

class iwls_api_request.api.iwls_public.IWLSapiPublic(query_handler, endpoint=<class 'iwls_api_request.api.endpoint.endpoint_public.EndpointPublic'>)[source]

Bases: IWLSapiABC

static _aggregate_benchmarks(futures)[source]

Méthode permettant d’agréger les données des repères des stations.

Parameters:: futures (Collection) – (Collection) Une collection de futures.
Return type:: tuple[list[dict], list[str]]
Returns:: (tuple) Une liste contenant les données agrégées et une liste contenant les erreurs.

_fetch_and_aggregate_benchmarks(function, station_ids)[source]

Méthode permettant de récupérer et d’agréger les données des repères des stations.

Parameters:

function (Callable) – (Callable) Une fonction permettant de récupérer les données des repères.
station_ids (Collection[str]) – (Collection[str]) Une liste contenant les identifiants des stations.

Return type:

Response

Returns:

(Response) Un objet Response contenant les informations sur les repères.

_get_benchmarks(station_id=None)[source]

Méthode permettant de récupérer les repères d’une station.

/api/v1/benchmarks

Parameters:: station_id (Optional[str]) – (str) L’identifiant d’une station.
Return type:: Response
Returns:: (Response) Un objet Response contenant les informations sur les repères.

get_all_stations(code=None, chs_region_code=None, time_serie_code=None)[source]

Méthode permettant de récupérer une liste de stations ainsi que les informations les concernant.

/api/v1/stations

Parameters:

code (Optional[str]) – (str) Le code d’une station. Écrase les autres paramètres.
chs_region_code (Optional[Regions]) – (Regions) Le code d’une région (PAC, CNA, ATL, QUE).
time_serie_code (Optional[TimeSeries]) – (TimeSeries) Le code de la série temporelle désirée. wlo : Official quality controlled water level observation wlp: Water level prediction for the next years wlp-hilo: Tide tables prediction for the next years wlp-bores : Bores arrival and intensity wcp-slack : Reversing falls wlf : Water level forecast for the next 48 hours wlf-spine dvcf-spine : Dynamic vertical clearance forecast under infrastructure like bridges

Return type:

Response

Returns:

(Response) Un objet Response contenant les stations ainsi que les informations les concernant

get_benchmark(benchmark_id)[source]

Méthode permettant de récupérer les informations d’un repère.

/api/v1/benchmarks/{benchmarkId}

Parameters:: benchmark_id (str) – (str) L’identifiant du repère.
Return type:: Response
Returns:: (Response) Un objet Response contenant les informations du repère.

get_benchmark_metadata(benchmark_id)[source]

Méthode permettant de récupérer les métadonnées d’un repère.

/api/v1/benchmarks/{benchmarkId}/metadata

Parameters:: benchmark_id (str) – (str) L’identifiant du repère.
Return type:: Response
Returns:: (Response) Un objet Response contenant les métadonnées du repère.

get_benchmarks(station_ids=None, **kwargs)[source]

Méthode permettant de récupérer les repères des stations.

/api/v1/benchmarks

Parameters:: station_ids (Collection[str]) – (Collection[str]) Une liste contenant les identifiants des stations.
Return type:: Response
Returns:: (Response) Un objet Response contenant les informations sur les repères.

get_elevations(benchmark_id)[source]

Méthode permettant de récupérer les métadonnées d’un repère.

/api/v1/benchmarks/{benchmarkId}/elevations

Parameters:: benchmark_id (str) – (str) L’identifiant du repère.
Return type:: Response
Returns:: (Response) Un objet Response contenant les métadonnées sur le repère.

get_height(height)[source]

Méthode permettant de récupérer un type de hauteur.

/api/v1/height-types/{heightTypeId}

Parameters:: height (str) – (str) L’identifiant de la hauteur.
Return type:: Response
Returns:: (Response) Un objet Response contenant les informations concernant ce type de hauteur.

get_height_types()[source]

Méthode permettant de récupérer les types de hauteur.

/api/v1/height-types

Return type:: Response
Returns:: (Response) Un objet Response contenant les différents types de hauteur.

get_info_station(station)[source]

Méthode permettant de récupérer les informations concernant une station.

/api/v1/stations/{stationId}

Parameters:: station (str) – (str) L’identifiant de la station.
Return type:: Response
Returns:: (Response) Un objet Response contenant les informations de la station.

get_metadata_station(station)[source]

Méthode permettant de récupérer les métadonnées concernant une station.

/api/v1/stations/{stationId}/metadata

Parameters:: station (str) – (str) Le stationId de la station.
Return type:: Response
Returns:: (Response) Un objet Response contenant les métadonnées de la station.

get_phenomena()[source]

Méthode permettant de récupérer les phénomènes.

/api/v1/phenomena

Return type:: Response
Returns:: (Response) Un objet Response contenant les différents phénomènes.

get_phenomenon(phenomenon)[source]

Méthode permettant de récupérer les informations d’un phénomène.

/api/v1/phenomena/{phenomenonId}

Return type:: Response
Returns:: (Response) Un objet Response contenant les informations concernant un phénomène.

get_station_daily_mean(station, from_time, to_time, time_zone=TimeZone.UTC)[source]

Méthode permettant d’obtenir les moyennes journalières pour une station.

/api/v1/stations/{stationId}/stats/calculate-daily-means

Parameters:

station (str) – (str) Le stationId de la station.
from_time (str) – (str) La date de début en format (ex: 2019-11-13).
to_time (str) – (str) La date de fin en format (ex: 2019-11-13).
time_zone (Optional[TimeZone]) – (TimeZone) Le fuseau horaire désiré.

Return type:

Response

Returns:

(Response) Un objet Response contenant les moyenne journalières de la station.

get_station_montly_mean(station, year, month, time_zone=TimeZone.UTC)[source]

Méthode permettant d’obtenir la moyenne mensuelle pour une station.

/api/v1/stations/{stationId}/stats/calculate-monthly-mean

Parameters:

station (str) – (str) Le stationId de la station.
year (str) – (str) L’année désirée.
month (str) – (str) Le mois désiré.
time_zone (Optional[TimeZone]) – (TimeZone) Le fuseau horaire désiré.

Return type:

Response

Returns:

(Response) Un objet Response contenant la moyenne mensuelle de la station.

get_tide_table(tide_table)[source]

Méthode permettant de recupérer une table de marées.

/api/v1/tide-tables/{tideTableId}

Parameters:: tide_table (str) – (str) L’identifiant d’une table de marées.
Return type:: Response
Returns:: (Response) Un objet Response contenant les informations d’une table de marées.

get_tide_tables(type_table=None, parent_tide_table=None)[source]

Méthode permettant de recupérer la liste des tables de marées.

/api/v1/tide-tables

Parameters:

type_table (Optional[TypeTideTable]) – (TypeTideTable) Un type de table. {VOLUME, AREA, SUB_AREA}
parent_tide_table (Optional[str]) – (str) L’identifiant d’une table.

Return type:

Response

Returns:

(Response) Un objet Response contenant l’ensemble des tables de marées correspondant aux critères de la recherche.

get_time_serie_data(station, from_time, to_time, time_serie_code=TimeSeries.WLO, time_resolution=TimeResolution.ONE_MINUTE)[source]

Méthode permttant de récupérer des données à partir de l’API de iWLS.

/api/v1/stations/{stationId}/data

Parameters:

station (str) – (str) Le stationId de la station.
time_serie_code (Optional[TimeSeries]) – (TimeSeries) Le code de la série temporelle désirée. wlo : Official quality controlled water level observation wlp: Water level prediction for the next years wlp-hilo: Tide tables prediction for the next years wlp-bores : Bores arrival and intensity wcp-slack : Reversing falls wlf : Water level forecast for the next 48 hours wlf-spine dvcf-spine : Dynamic vertical clearance forecast under infrastructure like bridges
from_time (str) – (str) La date de début en format ISO 8601 (ex: 2019-11-13T19:18:00Z).
to_time (str) – (str) La date de fin en format ISO 8601 (ex: 2019-11-13T19:18:00Z). La durée maximale est de 7 jours pour la majorité des TimeSeries.
time_resolution (Optional[TimeResolution]) – (TimeResolution) La résolution temporelle désirée.

Return type:

Response

Returns:

(Response) Un objet Response contenant les données reçues de l’API de iWLS.

get_time_serie_definition(time_serie_definition_id)[source]

Méthode permettant de récupérer la définition d’une série temporelle.

/api/v1/time-series-definitions/{timeSeriesDefinitionId}

Parameters:: time_serie_definition_id (str) – (str) L’identifiant de la série temporelle.
Return type:: Response
Returns:: (Response) Un objet Response contenant la définition de la série temporelle.

get_time_series_definitions(time_serie=None)[source]

Méthode permettant de récupérer les définitions des séries temporelles.

/api/v1/time-series-definitions

Parameters:: time_serie (Optional[TimeSeries]) – (TimeSeries) Le code de la série temporelle désirée.
Return type:: Response
Returns:: (Response) Un objet Response contenant les définitions des séries temporelles.

get_wlo_latest_data()[source]

Méthode permettant de récupérer les 20 dernières minutes de données de la série temporelle WLO pour toutes les stations.

/api/v1/stations/data/latest

Return type:: Response
Returns:: (Response) Un objet Response contenant les 20 dernières minutes de données de la série temporelle WLO.

_cache

_query_handler

endpoint

iwls_api_request.api.models_api module

class iwls_api_request.api.models_api.EndpointType(value)[source]

Bases: StrEnum

classmethod from_str(value)[source]

PRIVATE_DEV = 'EndpointPrivateDev'

PRIVATE_PROD = 'EndpointPrivateProd'

PUBLIC = 'EndpointPublic'

class iwls_api_request.api.models_api.Regions(value)[source]

Bases: StrEnum

static get_values()[source]

Return type:: list[str]

ATL = 'ATL'

CNA = 'CNA'

PAC = 'PAC'

QUE = 'QUE'

class iwls_api_request.api.models_api.TimeResolution(value)[source]

Bases: StrEnum

FIFTEEN_MINUTES = 'FIFTEEN_MINUTES'

FIVE_MINUTES = 'FIVE_MINUTES'

ONE_MINUTE = 'ONE_MINUTE'

SIXTY_MINUTES = 'SIXTY_MINUTES'

THREE_MINUTES = 'THREE_MINUTES'

class iwls_api_request.api.models_api.TimeSeries(value)[source]

Bases: StrEnum

classmethod from_str(value)[source]

static get_values()[source]

Return type:: list[str]

AP1 = 'ap1'

AP2 = 'ap2'

DVCF = 'dvcf'

DVCF_SPINE1 = 'dvcf-spine1'

V1 = 'v1'

V2 = 'v2'

WCDP = 'wcdp'

WCDP_EXTREMA = 'wcdp-extrema'

WCP_SLACK = 'wcp-slack'

WCSP = 'wcsp'

WCSP_EXTREMA = 'wcsp-extrema'

WL1 = 'wl1'

WL2 = 'wl2'

WL3 = 'wl3'

WLF = 'wlf'

WLF_SPINE = 'wlf-spine'

WLF_VTG = 'wlf-vtg'

WLO = 'wlo'

WLP = 'wlp'

WLP_BORES = 'wlp-bores'

WLP_HILO = 'wlp-hilo'

WS1 = 'ws1'

WS2 = 'ws2'

WT1 = 'wt1'

WT2 = 'wt2'

WT3 = 'wt3'

class iwls_api_request.api.models_api.TimeZone(value)[source]

Bases: StrEnum

LOCAL = 'LOCAL'

UTC = 'UTC'

class iwls_api_request.api.models_api.TypeTideTable(value)[source]

Bases: StrEnum

AREA = 'AREA'

SUB_AREA = 'SUB_AREA'

VOLUME = 'VOLUME'

Module contents

class iwls_api_request.api.Endpoint(API, TYPE, BENCHMARK, BENCHMARKS, BENCHMARK_METADATA, ELEVVATIONS, HEIGHT_TYPE, HEIGHT_TYPES, PHENOMENA, PHENOMENON, STATION, STATIONS, STATION_DATA, STATION_METADATA, TIDE_TABLE, TIDE_TABLES, TIME_SERIES_DEFINITION, TIME_SERIE_DEFINITION, GNSS_STATION=None, GNSS_STATIONS=None, GNSS_SUM=None, REGIONS=None, STATION_DATA_LATEST=None, STATION_TIME_SERIES=None, STATION_STATS_DAILY=None, STATION_STATS_MONTHLY=None)[source]

Bases: ABC

Classe abstraite pour les points d’entrés de l’API.

Parameters:

API (str) – URL de l’API.
TYPE (EndpointType) – Type de l’API.
BENCHMARK (str) – Point d’entrée pour un repère.
BENCHMARKS (str) – Point d’entrée pour les repères.
BENCHMARK_METADATA (str) – Point d’entrée pour les métadonnées d’un repère.
ELEVVATIONS (str) – Point d’entrée pour les élévations d’un repère.
HEIGHT_TYPE (str) – Point d’entrée pour un type de hauteur.
HEIGHT_TYPES (str) – Point d’entrée pour les types de hauteurs.
PHENOMENA (str) – Point d’entrée pour les phénomènes.
PHENOMENON (str) – Point d’entrée pour un phénomène.
STATION (str) – Point d’entrée pour une station.
STATIONS (str) – Point d’entrée pour les stations.
STATION_DATA (str) – Point d’entrée pour les données d’une station.
STATION_METADATA (str) – Point d’entrée pour les métadonnées d’une station.
TIDE_TABLE (str) – Point d’entrée pour une table des marées.
TIDE_TABLES (str) – Point d’entrée pour les tables des marées.
TIME_SERIES_DEFINITION (str) – Point d’entrée pour les définitions de séries temporelles.
TIME_SERIE_DEFINITION (str) – Point d’entrée pour une définition de série temporelle.
GNSS_STATION (Optional[str]) – Point d’entrée pour une station GNSS.
GNSS_STATIONS (Optional[str]) – Point d’entrée pour les stations GNSS.
GNSS_SUM (Optional[str]) – Point d’entrée pour le sommaire des données GNSS.
REGIONS (Optional[str]) – Point d’entrée pour les régions.
STATION_DATA_LATEST (Optional[str]) – Point d’entrée pour les dernières données d’une station.
STATION_TIME_SERIES (Optional[str]) – Point d’entrée pour les séries temporelles d’une station.
STATION_STATS_DAILY (Optional[str]) – Point d’entrée pour les statistiques journalières d’une station.
STATION_STATS_MONTHLY (Optional[str]) – Point d’entrée pour les statistiques mensuelles d’une station.

API: str

BENCHMARK: str

BENCHMARKS: str

BENCHMARK_METADATA: str

ELEVVATIONS: str

GNSS_STATION: str | None

GNSS_STATIONS: str | None

GNSS_SUM: str | None

HEIGHT_TYPE: str

HEIGHT_TYPES: str

PHENOMENA: str

PHENOMENON: str

REGIONS: str | None

STATION: str

STATIONS: str

STATION_DATA: str

STATION_DATA_LATEST: str | None

STATION_METADATA: str

STATION_STATS_DAILY: str | None

STATION_STATS_MONTHLY: str | None

STATION_TIME_SERIES: str | None

TIDE_TABLE: str

TIDE_TABLES: str

TIME_SERIES_DEFINITION: str

TIME_SERIE_DEFINITION: str

TYPE: EndpointType

class iwls_api_request.api.EndpointPrivateDev(API='', TYPE=EndpointType.PRIVATE_DEV, BENCHMARK='benchmarks/{benchmarkId}', BENCHMARKS='benchmarks/', BENCHMARK_METADATA='benchmarks/{benchmarkId}/metadata', ELEVVATIONS='benchmarks/{benchmarkId}/elevations', HEIGHT_TYPE='heights/{heightTypeId}', HEIGHT_TYPES='heights/', PHENOMENA='phenomena/', PHENOMENON='phenomena/{phenomenonId}', STATION='stations/{stationId}', STATIONS='stations/', STATION_DATA='stations/{stationId}/time-series/{tsId}/data', STATION_METADATA='stations/{stationId}/metadata', TIDE_TABLE='tideTables/{tideTableId}', TIDE_TABLES='tideTables/', TIME_SERIES_DEFINITION='time-series-definitions/', TIME_SERIE_DEFINITION='time-series-definitions/{id}', GNSS_STATION='stations/{stationId}/gnss/{gnssId}', GNSS_STATIONS='stations/{stationId}/gnss', GNSS_SUM='stations/{stationId}/gnss/{gnssId}/sum', REGIONS='chsRegions/', STATION_DATA_LATEST=None, STATION_TIME_SERIES='stations/{stationId}/time-series/', STATION_STATS_DAILY=None, STATION_STATS_MONTHLY=None)[source]

Bases: EndpointPrivate

Classe pour les points d’entrés de l’API privée de développement.

class iwls_api_request.api.EndpointPrivateProd(API='', TYPE=EndpointType.PRIVATE_PROD, BENCHMARK='benchmarks/{benchmarkId}', BENCHMARKS='benchmarks/', BENCHMARK_METADATA='benchmarks/{benchmarkId}/metadata', ELEVVATIONS='benchmarks/{benchmarkId}/elevations', HEIGHT_TYPE='heights/{heightTypeId}', HEIGHT_TYPES='heights/', PHENOMENA='phenomena/', PHENOMENON='phenomena/{phenomenonId}', STATION='stations/{stationId}', STATIONS='stations/', STATION_DATA='stations/{stationId}/time-series/{tsId}/data', STATION_METADATA='stations/{stationId}/metadata', TIDE_TABLE='tideTables/{tideTableId}', TIDE_TABLES='tideTables/', TIME_SERIES_DEFINITION='time-series-definitions/', TIME_SERIE_DEFINITION='time-series-definitions/{id}', GNSS_STATION='stations/{stationId}/gnss/{gnssId}', GNSS_STATIONS='stations/{stationId}/gnss', GNSS_SUM='stations/{stationId}/gnss/{gnssId}/sum', REGIONS='chsRegions/', STATION_DATA_LATEST=None, STATION_TIME_SERIES='stations/{stationId}/time-series/', STATION_STATS_DAILY=None, STATION_STATS_MONTHLY=None)[source]

Bases: EndpointPrivate

Classe pour les points d’entrés de l’API privée de production.

class iwls_api_request.api.EndpointPublic(API='https://api-iwls.dfo-mpo.gc.ca/api/v1/', TYPE=EndpointType.PUBLIC, BENCHMARK='benchmarks/{benchmarkId}', BENCHMARKS='benchmarks', BENCHMARK_METADATA='benchmarks/{benchmarkId}/metadata', ELEVVATIONS='benchmarks/{benchmarkId}/elevations', HEIGHT_TYPE='height-types/{heightTypeId}', HEIGHT_TYPES='height-types', PHENOMENA='phenomena', PHENOMENON='phenomena/{phenomenonId}', STATION='stations/{stationId}', STATIONS='stations', STATION_DATA='stations/{stationId}/data', STATION_METADATA='stations/{stationId}/metadata', TIDE_TABLE='tide-tables/{tideTableId}', TIDE_TABLES='tide-tables', TIME_SERIES_DEFINITION='time-series-definitions/', TIME_SERIE_DEFINITION='time-series-definitions/{timeSeriesDefinitionId}', GNSS_STATION=None, GNSS_STATIONS=None, GNSS_SUM=None, REGIONS=None, STATION_DATA_LATEST='stations/data/latest', STATION_TIME_SERIES=None, STATION_STATS_DAILY='stations/{stationId}/stats/calculate-daily-means', STATION_STATS_MONTHLY='stations/{stationId}/stats/calculate-monthly-mean')[source]

Bases: Endpoint

Classe pour les points d’entrés de l’API publique.

class iwls_api_request.api.EndpointType(value)[source]

Bases: StrEnum

classmethod from_str(value)[source]

PRIVATE_DEV = 'EndpointPrivateDev'

PRIVATE_PROD = 'EndpointPrivateProd'

PUBLIC = 'EndpointPublic'