Struct Client 

pub struct Client { /* private fields */ }

An async client for the UK Police API.

Example

let client = uk_police_api::Client::new();
let forces = client.forces().await?;

Implementations

impl Client

pub fn new() -> Self

pub fn from_http_client(http: Client) -> Self

Creates a client with a pre-configured reqwest::Client.

Use this to customize timeouts, headers, proxies, or any other HTTP behaviour.

Example

let http = reqwest::Client::builder()
    .timeout(std::time::Duration::from_secs(10))
    .build()
    .unwrap();
let client = uk_police_api::Client::from_http_client(http);

pub async fn forces(&self) -> Result<Vec<Force>, Error>

Returns a list of all police forces.

pub async fn force(&self, id: &str) -> Result<ForceDetail, Error>

Returns details for a specific police force.

pub async fn crime_categories( &self, date: Option<&str>, ) -> Result<Vec<CrimeCategory>, Error>

Returns a list of crime categories. Optionally filtered by date (format: YYYY-MM).

pub async fn street_level_crimes( &self, category: &str, area: &Area, date: Option<&str>, ) -> Result<Vec<Crime>, Error>

Returns street-level crimes within a given area.

Arguments

• category - Crime category slug (e.g. “all-crime”, “burglary”). See Client::crime_categories.
• area - Either a point (1 mile radius) or a custom polygon.
• date - Optional month filter (format: YYYY-MM). Defaults to the latest available.

pub async fn street_level_outcomes( &self, area: &Area, date: Option<&str>, ) -> Result<Vec<Outcome>, Error>

Returns street-level outcomes at a given location.

Arguments

• area - A point (1 mile radius), custom polygon, or specific location ID.
• date - Optional month filter (format: YYYY-MM). Defaults to the latest available.

pub async fn crime_last_updated(&self) -> Result<CrimeLastUpdated, Error>

Returns the date when crime data was last updated.

pub async fn senior_officers( &self, force_id: &str, ) -> Result<Vec<SeniorOfficer>, Error>

Returns a list of senior officers for a given force.

pub async fn crimes_at_location( &self, location_id: u64, date: Option<&str>, ) -> Result<Vec<Crime>, Error>

Returns crimes at a specific location.

Arguments

• location_id - A location ID (from a street’s id field).
• date - Optional month filter (format: YYYY-MM). Defaults to the latest available.

pub async fn crimes_no_location( &self, category: &str, force: &str, date: Option<&str>, ) -> Result<Vec<Crime>, Error>

Returns crimes that could not be mapped to a location.

Arguments

• category - Crime category slug (e.g. “all-crime”). See Client::crime_categories.
• force - Force identifier (e.g. “metropolitan”).
• date - Optional month filter (format: YYYY-MM). Defaults to the latest available.

pub async fn outcomes_for_crime( &self, persistent_id: &str, ) -> Result<CrimeOutcomes, Error>

Returns all outcomes for a specific crime.

Arguments

• persistent_id - The 64-character crime identifier.

pub async fn neighbourhoods( &self, force_id: &str, ) -> Result<Vec<Neighbourhood>, Error>

Returns a list of neighbourhoods for a force.

pub async fn neighbourhood( &self, force_id: &str, neighbourhood_id: &str, ) -> Result<NeighbourhoodDetail, Error>

Returns details for a specific neighbourhood.

pub async fn neighbourhood_boundary( &self, force_id: &str, neighbourhood_id: &str, ) -> Result<Vec<LatLng>, Error>

Returns the boundary of a neighbourhood as a list of lat/lng pairs.

pub async fn neighbourhood_team( &self, force_id: &str, neighbourhood_id: &str, ) -> Result<Vec<SeniorOfficer>, Error>

Returns the policing team for a neighbourhood.

pub async fn neighbourhood_events( &self, force_id: &str, neighbourhood_id: &str, ) -> Result<Vec<NeighbourhoodEvent>, Error>

Returns events for a neighbourhood.

pub async fn neighbourhood_priorities( &self, force_id: &str, neighbourhood_id: &str, ) -> Result<Vec<NeighbourhoodPriority>, Error>

Returns policing priorities for a neighbourhood.

pub async fn locate_neighbourhood( &self, lat: f64, lng: f64, ) -> Result<LocateNeighbourhoodResult, Error>

Locates the neighbourhood policing team responsible for a given point.

pub async fn stops_street( &self, area: &Area, date: Option<&str>, ) -> Result<Vec<StopAndSearch>, Error>

Returns stop and searches within a given area.

Arguments

• area - A point (1 mile radius) or custom polygon.
• date - Optional month filter (format: YYYY-MM). Defaults to the latest available.

pub async fn stops_at_location( &self, location_id: u64, date: Option<&str>, ) -> Result<Vec<StopAndSearch>, Error>

Returns stop and searches at a specific location.

Arguments

• location_id - A location ID (from a street’s id field).
• date - Optional month filter (format: YYYY-MM). Defaults to the latest available.

pub async fn stops_no_location( &self, force: &str, date: Option<&str>, ) -> Result<Vec<StopAndSearch>, Error>

Returns stop and searches that could not be mapped to a location.

Arguments

• force - Force identifier (e.g. “metropolitan”).
• date - Optional month filter (format: YYYY-MM). Defaults to the latest available.

pub async fn stops_force( &self, force: &str, date: Option<&str>, ) -> Result<Vec<StopAndSearch>, Error>

Returns stop and searches reported by a force.

Arguments

• force - Force identifier (e.g. “metropolitan”).
• date - Optional month filter (format: YYYY-MM). Defaults to the latest available.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for Client

fn default() -> Self

Returns the “default value” for a type.