---
title: "GET /atms"
method: GET
path: "/atms"
tags: ["ATM"]
---

# GET /atms

`GET /atms`

Gets a list of all `ATM` objects.

## Headers

- `User-Agent` string
- `If-Modified-Since` string
- `If-None-Match` string

## Response `200`

Successful response with a list of `ATM` data

- object
  - `meta` object, required
    - `LastUpdated` string, date-time, required
    - `TotalResults` integer, required
    - `License` string, uri, required — Open Banking License
    - `TermsOfUse` string, uri, required — Open Banking Terms of Use
  - `data` object[], required
    - `ParentGroupName` string, required — Parent company that owns or partially owns subsidiary organisations. ATM Operator Organisation.
    - `ParentGroupID` string, required — Unique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme
    - `Brand` object, required — Brand Organisation
      - `BrandName` string, required — Name by which an organisation is known that is printed on top of the ATM
      - `BrandID` string — Unique and unambiguous way to identify the organisation that is shown on top of the ATM
    - `BranchIdentification` string — Unique and unambiguous identification of a retail branch of a financial institution
    - `ATMID` string, required — ATM terminal device identification for the acquirer and the issuer
    - `LocationCategory` 'Airport' | 'Bank Office' | 'Bank Specialised Outlet' | 'Branch' | 'Branch Customer Area' | 'Branch Lobby' | 'Branch Wall' | 'Bureau de Change' | 'Coach Station' | 'Convenience Store' | 'Exhibition Centre' | 'Factory' | 'Office' | 'Financial Institution' | 'Hospital' | 'Hotel' | 'House of Commons' | 'House of Lords' | 'Leisure Centre' | 'Ministry of Defence' | 'Motorway Services' | 'Petrol Station' | 'Pleasure Park' | 'Public House' | 'Railway Station' | 'Railway Station (Underground)' | 'Remote Unit' | 'Retailer' | 'Department Store' | 'Retailer Outlet' | 'Seaport' | 'Shopping Centre' | 'Supermarket' | 'University' | 'College' | 'Bank External' | 'Restricted Access' | 'Commercial Space' — Indicates the environment of the ATM
    - `SiteID` string — Site identifying code, where ATM is located
    - `SiteName` string — Site identifying name, where ATM is located
    - `Address` object, required — Postal Address
      - `StrtNm` string, required — Name of a street or thoroughfare
      - `BuildingNameOrNumber` string — Number or Name that identifies the position of a building on a street
      - `PstCd` string, required — Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail
      - `OptionalAddressField` string — Additional field; often directions
      - `TwnNm` string — Name of a built-up area, with defined boundaries, and a local government
      - `CtrySubDvsn` string — Identifies a subdivision of a country such as state, region, county
      - `Ctry` string, required — Nation with its own government
    - `GeographicLocation` object, required — Geographic Coordinates
      - `Lat` string, required — Latitude measured in degrees, minutes and seconds, following by 'N' for North and 'S' for South of the Equator (for example 48°51'29'' N for the Eiffel Tower latitude)
      - `Long` string, required — Angular measurement of the distance of a location on the Earth East or West of the Greenwich Observatory. The longitude is measured in degrees, minutes and seconds, following by 'E' for East and 'W' for West (for example 2°17'4'' E for the Eiffel Tower longitude)
    - `AccessibilityTypes` string[] — Information about the accessibility
    - `SupportedLanguages` string[], required — Languages that the ATM supports
    - `ATMServices` array[], required — Information about ATM services
      - string[] — Information about ATM services
    - `AdditionalATMServices` string[]
    - `Currency` string[], required — Defines currency type available for dispense
    - `MinimumValueDispensed` '£ 5' | '£ 10' | '£ 20' | '£ 50' | '£ 100' — Minimum currency denominations usually available

## Other responses

- `400` — You have sent a request which could not be understood.
- `408` — Your client has failed to submit a request, and a timeout has occurred.
- `429` — You have requested this resource too often. Slow down.
- `500` — An error occurred on the server. No further information is available.
- `503` — The service is temporarily unavailable.
- `default` — A standard error response.

---

[API](https://skmtc.dev/openbankinguk/apis/open-data-api.md) · [All operations](https://skmtc.dev/openbankinguk/apis/open-data-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/openbankinguk/open-data-api/revisions/f25ce98e62b1/schema)
