Class ObservationClient

constructor

• new ObservationClient(options?: ObservationClientOptions): ObservationClient

  The main client for interacting with the Waarneming.nl API.

  Parameters

  • Optionaloptions: ObservationClientOptions

    Configuration options for the client.

  Returns ObservationClient

Readonlyobservations

Readonlyspecies

Readonlyregions

Readonlylocations

ReadonlyregionSpeciesLists

Readonlyusers

Readonlycountries

Readonlybadges

Readonlygroups

Readonlyexports

Readonlylanguages

Readonlylookups

Readonlynia

Readonlymedia

Readonlysessions

Readonlychallenges

Readonlyinterceptors

setLanguage

• setLanguage(language: string): void

  Sets the language for the Accept-Language header in all subsequent API requests. The default language is 'en'.

  Parameters

  • language: string

    The two-letter language code (e.g., 'nl', 'en', 'de').

  Returns void

getApiBaseUrl

• getApiBaseUrl(): string
  Internal

  Gets the base URL for the API.

  Returns string

  The base URL.

getAuthorizationUrl

• getAuthorizationUrl(state: string, scope: string[]): string

  Generates the authorization URL for the OAuth2 Authorization Code Grant flow. The user should be redirected to this URL to authorize the application.

  Parameters

  • state: string

    A random string to protect against CSRF attacks.
  • scope: string[]

    An array of scopes the application is requesting.

  Returns string

  The full authorization URL to redirect the user to.

  Throws

  If the client options (clientId, redirectUri) are not configured.

getAccessToken

• getAccessToken(code: string): Promise<TokenResponse>

  Exchanges an authorization code for an access token using the Authorization Code Grant flow.

  Parameters

  • code: string

    The authorization code received from the callback URL after user authorization.

  Returns Promise<TokenResponse>

  A promise that resolves to the token response from the API.

  Throws

  If the token request fails.

  Throws

  If the client options are not configured.

getAccessTokenWithPassword

• getAccessTokenWithPassword(
      options: PasswordGrantOptions,
  ): Promise<TokenResponse>

  Fetches an access token using the Resource Owner Password Credentials Grant. Use this grant type only for trusted applications.

  Parameters

  • options: PasswordGrantOptions

    The credentials for the password grant.

  Returns Promise<TokenResponse>

  A promise that resolves to the token response.

  Throws

  If the token request fails.

refreshAccessToken

• refreshAccessToken(): Promise<TokenResponse>

  Refreshes an expired access token using a refresh token.

  Returns Promise<TokenResponse>

  A promise that resolves to the new token response.

  Throws

  If the refresh token request fails.

  Throws

  If the refresh token or client options are not available.

setAccessToken

• setAccessToken(token: string): void

  Manually sets the access token for the client to use in subsequent authenticated requests.

  Parameters

  • token: string

    The access token.

  Returns void

setRefreshToken

• setRefreshToken(token: string): void
  Internal

  Manually sets the refresh token for the client.

  Parameters

  • token: string

    The refresh token.

  Returns void

hasAccessToken

• hasAccessToken(): boolean

  Checks if an access token is currently set on the client.

  Returns boolean

  true if an access token is set, false otherwise.

hasRefreshToken

• hasRefreshToken(): boolean

  Checks if a refresh token is currently set on the client.

  Returns boolean

  true if a refresh token is set, false otherwise.

getCurrentAccessToken

• getCurrentAccessToken(): null | string
  Internal

  Gets the current access token.

  Returns null | string

  The access token or null if not set.

request

• request<T>(endpoint: string, options?: FetchOptions): Promise<T>

  Makes an authenticated request to the API. An access token must be set via setAccessToken or by using one of the authentication flows.

  Type Parameters

  • T

  Parameters

  • endpoint: string

    The API endpoint to request.
  • options: FetchOptions = {}

    Optional request options, including URL parameters.

  Returns Promise<T>

  A promise that resolves to the JSON response.

  Throws

  If the access token is not set or the request is unauthorized.

  Throws

  If the API request fails for other reasons.

publicRequest

• publicRequest<T>(endpoint: string, options?: FetchOptions): Promise<T>

  Makes a public (unauthenticated) request to the API.

  Type Parameters

  • T

  Parameters

  • endpoint: string

    The API endpoint to request.
  • options: FetchOptions = {}

    Optional request options, including URL parameters.

  Returns Promise<T>

  A promise that resolves to the JSON response.

  Throws

  If the API request fails.