Skip to content

Branch Locator API API

by hsbc.com

No authHTTPSFinance
Open documentation ↗

Overview

HSBC, one of the largest banking and financial services institutions in the world, serves millions of customers through its four global businesses.

Branch Locator API is a finance API from hsbc.com. It needs no API key. It is served over HTTPS. Its OpenAPI description documents 6 endpoints.

At a glance

Authentication
No auth
HTTPS
Yes
CORS
Unknown
Category
Finance
Base URL
https://dikpeqbnwi3kx.cloudfront.net
Version
2.2.1
Endpoints
6
Spec updated
2021-06-21

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

cURL
curl -X GET "https://dikpeqbnwi3kx.cloudfront.net/open-banking/v2.2/branches" \
  -H "Accept: application/json"
JavaScript
const response = await fetch("https://dikpeqbnwi3kx.cloudfront.net/open-banking/v2.2/branches", {
  method: "GET",
  headers: {
    "Accept": "application/json",
  },
});
const data = await response.json();
console.log(data);
Python
import requests

response = requests.request(
    "GET",
    "https://dikpeqbnwi3kx.cloudfront.net/open-banking/v2.2/branches",
    headers={
    "Accept": "application/json",
    },
    timeout=30,
)
print(response.json())

Endpoints

MethodPathWhat it does
GET/open-banking/v2.2/branchesThis API will return the branch details for all branches and is prepared to the Open Banking standards as defined by the Open Banking Implementation Entity (OBI
GET/x-open-banking/v2.2/branches/country/{country}This extended API will return the branch details for all branches in the specified country. It is based-on the Open Banking standards as defined by the Open Ban
GET/x-open-banking/v2.2/branches/country/{country}/town/{town}This extended API will return the branch details for all branches in the specified town. It is based-on the Open Banking standards as defined by the Open Bankin
GET/x-open-banking/v2.2/branches/geo-location/lat/{latitude}/long/{longitude}This API will return the branch details for all branches within a specified radius (1 to 10 miles) of the specified latitude and longitude. It is based-on the O
GET/x-open-banking/v2.2/branches/postcode/{postcode}This extended API will return the branch details for all branches within a 5 mile radius of the specified postcode. It is based-on the Open Banking standards as
GET/x-open-banking/v2.2/branches/sortcode/{sortcode}This extended API will return the branch details for a branch specified by its sort code. It is based-on the Open Banking standards as defined by the Open Banki

Questions

Does the Branch Locator API API need an API key?

No. The Branch Locator API API can be called without an API key or sign-up, which makes it handy for prototypes and front-end demos.

Does the Branch Locator API API support HTTPS?

Yes, the Branch Locator API API is served over HTTPS.

How many endpoints does the Branch Locator API API have?

Its OpenAPI description lists 6 endpoints in version 2.2.1. All of them are shown on this page.

What are alternatives to the Branch Locator API API?

Other Finance APIs include Stripe, SEC EDGAR Data, Plaid, Fed Treasury, Razorpay IFSC.

Compare alternatives →

Listed from APIs.guru (CC0).