Whapi

Locations

The Locations API is a collection of methods that support geographical information. The first method is an address lookup service for UK addresses. This…

Media & content#openapi#entertainment

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

The Locations API is a collection of methods that support geographical information. The first method is an address lookup service for UK addresses. This service can be used to provide a new customer with a list of possible addresses from which they can populate a registration form.

Endpoints 5

Locations

  • GETaddressLookup/address/lookup/?houseNum=string&postCode=stringRetrieves a list of addresses when supplied with a house number or name and a postcode. It is generally used during customer registration to provide a list of…
  • GETgetCountries/countries/Retrieves a list of countries and its currencies.
  • GETgetCountry/countries/:countryCodeRetrieves the specified country and its currency.
  • GETgetCurrencies/currencies/Retreives the list of currencies.
  • GETgetCurrency/currencies/:currencyCodeRetreives the specified currency.

API details

Base URL
https://sandbox.whapi.com/v2/locations
Authentication
An API key in the apiKey header
Operations
5 operations on 5 pathsGET 5
Main resources
Locations 5
Response formats
application/json
Description format
Swagger 2.0, API version 2.0
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Locations in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Locations collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the apiKey header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “addressLookup” (GET /address/lookup/?houseNum=string&postCode=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Locations?

The Locations API is a collection of methods that support geographical information. The first method is an address lookup service for UK addresses. This… It is listed under Media & content and has 5 endpoints.

Who publishes the Locations?

It is listed from Whapi's public API description (an OpenAPI document), not published by Whapi on Swastik Codes. Anyone who controls whapi.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Locations?

Requests go to https://sandbox.whapi.com/v2/locations. Endpoint paths are added to this base URL.

How do I authenticate with the Locations?

With an API key in the apiKey header.

How many endpoints does the Locations have?

5 operations on 5 paths (5 GET). The largest groups are Locations.

Is forking the Locations free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.