Expand description
Async client for the free Netherlands postcode API at https://postcode.tech.
There are two methods, one to find the street and city matching the supplied postcode and house number, and one that also includes the municipality, province and coordinates. If no address can be found for the postcode and house number combination, None
is returned.
§Example
// Initialize a client
let client = PostcodeClient::new("YOUR_API_TOKEN");
// Find the address matching on a postcode and house number
let (address, limits) = client.get_address("1012RJ", 147).await?;
// Find the address and additional location information such as municipality, province and coordinates
let (address, limits) = client.get_extended_address("1012RJ", 147).await?;
§Usage Limits
As of the latest release of this crate, API usage is limited to 10,000 requests per day as well as 600 requests per 30 seconds. Please do not abuse this free service and ruin it for everyone else. ApiLimits
, included with the address response as shown above, reports the API limits (extracted from the response headers). The library validates the inputs in order to avoid making requests with invalid inputs, which would count towards the usage limits.
§Disclaimer
I am not affiliated with the API provider and as such cannot make guarantees to the correctness of the results or the availability of the underlying service. Refer to https://postcode.tech for the service terms and conditions.
Structs§
- Address
- Simple address response.
- ApiLimits
- Usage limits of the API, returned with every request
- Coordinates
- Coordinates of the address
- Extended
Address - Extended address response.
- Postcode
Client - The client that calls the API.
Enums§
- Postcode
Error - Possible errors when fetching an address.