Struct ZipCodeStackClient 

pub struct ZipCodeStackClient { /* private fields */ }

Async client for the zipcodestack.com API.

Implementations

impl ZipCodeStackClient

pub fn builder<S: Into<String>>(api_key: S) -> ZipCodeStackClientBuilder

Start building a ZipCodeStackClient.

pub fn new<S: Into<String>>(api_key: S) -> Self

Convenience constructor with defaults.

pub async fn status(&self) -> Result<StatusResponse, ZipCodeStackError>

Query the API status and (optionally) quota usage.

Endpoint path used: /status

pub async fn search_zip( &self, zip_code: &str, country: Option<&str>, ) -> Result<ZipSearchResponse, ZipCodeStackError>

Search for details about a zip/postal code.

Endpoint path used: /search Supported query params: zip_code, optional country

pub async fn distance_between( &self, from_zip: &str, to_zip: &str, unit: Option<DistanceUnit>, ) -> Result<DistanceResponse, ZipCodeStackError>

Compute distance between two zip/postal codes.

Endpoint path used: /distance Supported query params: from, to, optional unit (“miles” | “kilometers”)