Class Locations

Index

Constructors

Methods

search get getSpeciesSeen getSpeciesSeenAroundPoint getGeoJSON

Constructors

constructor

new Locations(client: ObservationClient): Locations
Internal
Parameters
- client: ObservationClient
Returns Locations
- Defined in lib/locations.ts:15

Methods

search

search(
params: { name?: string } | { lat: number; lng: number },
): Promise<Paginated<Location>>
Searches for locations by name or by proximity to a geographic point.

When coordinates are provided exactly one location is returned: the smallest location containing the point, or the smallest closest location otherwise.
Parameters
- params: { name?: string } | { lat: number; lng: number }
  The search parameters, either a name string or a lat/lng coordinate pair.
Returns Promise<Paginated<Location>>
A promise that resolves to a paginated list of matching locations.

Throws
If the request is not authenticated.

Throws
If the request fails.
- Defined in lib/locations.ts:30

get

get(id: number): Promise<Location>
Retrieves the details for a single location by its ID.
Parameters
- id: number
  The unique identifier of the location.
Returns Promise<Location>
A promise that resolves to the location object.

Throws
If the request is not authenticated.

Throws
If the request fails.
- Defined in lib/locations.ts:53

getSpeciesSeen

getSpeciesSeen(
    id: number,
    params?: {
        end_date?: string;
        days?: number;
        species_group?: number;
        rarity?: number;
        fast?: boolean;
    },
): Promise<{ results: SpeciesSeen[] }>
Lists all species seen at a specific location, with optional filters.
Parameters
- id: number
  The unique identifier of the location.
- params: {
      end_date?: string;
      days?: number;
      species_group?: number;
      rarity?: number;
      fast?: boolean;
  } = {}
  Optional query parameters to filter the results (e.g., date, species group).
Returns Promise<{ results: SpeciesSeen[] }>
A promise that resolves to a list of species seen at the location.

Throws
If the request is not authenticated.

Throws
If the request fails.
- Defined in lib/locations.ts:66

getSpeciesSeenAroundPoint

getSpeciesSeenAroundPoint(
    params: {
        lat: number;
        lng: number;
        radius?: number;
        end_date?: string;
        days?: number;
        species_group?: number;
        rarity?: number;
        fast?: boolean;
        order_by?: string;
    },
): Promise<{ results: SpeciesSeen[] }>
Lists all species seen in a radius around a specified point, with optional filters.
Parameters
- params: {
      lat: number;
      lng: number;
      radius?: number;
      end_date?: string;
      days?: number;
      species_group?: number;
      rarity?: number;
      fast?: boolean;
      order_by?: string;
  }
  The query parameters, including lat, lng, and optional radius, filters, etc.
Returns Promise<{ results: SpeciesSeen[] }>
A promise that resolves to a list of species seen around the point.

Throws
If the request is not authenticated.

Throws
If the request fails.
- Defined in lib/locations.ts:95

getGeoJSON

getGeoJSON(
    params:
        | { coordinates: string; model?: string }
        | { id: number; model?: string },
): Promise<GeoJSONFeatureCollection<GeoJSONGeometry>>
Fetches a GeoJSON FeatureCollection with location geometry and properties. This is a public endpoint.
Parameters
- params: { coordinates: string; model?: string } | { id: number; model?: string }
  The query parameters, either coordinates (lat,lng pair) or a location id.
Returns Promise<GeoJSONFeatureCollection<GeoJSONGeometry>>
A promise that resolves to a GeoJSON FeatureCollection.

Throws
If the request fails.
- Defined in lib/locations.ts:128