List banks

Every bank in the Bits BIC register, optionally filtered by a free text query.

GET/v1/banks

Authorization

Optional — this operation also accepts unauthenticated requests.

x-api-keyAPI key · header

API key issued from the dashboard. Optional: anonymous callers are served at a lower rate limit.

AuthorizationBearer token · header

The same API key, sent as a bearer token.

Query parameters

qstring

Search by name or BIC

min length 1

limitinteger

min 1 · max 200 · default: 100

offsetinteger

min 0 · max 9007199254740991 · default: 0

Responses

200Default Response

dataBank[]required

Show properties

Array of Bank

bicstringrequired

ISO 9362 BIC, 8 or 11 characters

matches ^[A-Z]{6}[A-Z0-9]{2}([A-Z0-9]{3})?$

institutionCodestringrequired

First four BIC characters

namestringrequired

countrystringrequired

clearingCodesstring[]required

logoBankLogo | anyrequired

Show properties

Any of:

BankLogo

formatsstring[]required

hashstringrequired

urlstring<uri>required

Immutable URL for the preferred format

any

any

metaobjectrequired

Show properties

totalintegerrequired

min -9007199254740991 · max 9007199254740991

limitintegerrequired

min -9007199254740991 · max 9007199254740991

offsetintegerrequired

min -9007199254740991 · max 9007199254740991

datasetVersionstringrequired

400Default Response

typestring<uri>required

titlestringrequired

statusintegerrequired

min -9007199254740991 · max 9007199254740991

codestringrequired

detailstring

instancestring

errorsobject[]

Show properties

Array of object

pathstringrequired

messagestringrequired

401Default Response

typestring<uri>required

titlestringrequired

statusintegerrequired

min -9007199254740991 · max 9007199254740991

codestringrequired

detailstring

instancestring

errorsobject[]

Show properties

Array of object

pathstringrequired

messagestringrequired

404Default Response

typestring<uri>required

titlestringrequired

statusintegerrequired

min -9007199254740991 · max 9007199254740991

codestringrequired

detailstring

instancestring

errorsobject[]

Show properties

Array of object

pathstringrequired

messagestringrequired

429Default Response

typestring<uri>required

titlestringrequired

statusintegerrequired

min -9007199254740991 · max 9007199254740991

codestringrequired

detailstring

instancestring

errorsobject[]

Show properties

Array of object

pathstringrequired

messagestringrequired

500Default Response

typestring<uri>required

titlestringrequired

statusintegerrequired

min -9007199254740991 · max 9007199254740991

codestringrequired

detailstring

instancestring

errorsobject[]

Show properties

Array of object

pathstringrequired

messagestringrequired

Request

curl -X GET "http://localhost:8080/v1/banks" \
  -H "x-api-key: YOUR_API_KEY"

const response = await fetch("http://localhost:8080/v1/banks", {
  method: "GET",
  headers: {
    "x-api-key": "YOUR_API_KEY"
  }
});

import requests

response = requests.get(
    "http://localhost:8080/v1/banks",
    headers={
        "x-api-key": "YOUR_API_KEY"
    },
)

Response

{
  "data": [
    {
      "bic": "DNBANOKK",
      "institutionCode": "DNBA",
      "name": "DNB Bank ASA",
      "country": "NO",
      "clearingCodes": [
        "1503"
      ],
      "logo": {
        "formats": [
          "svg"
        ],
        "hash": "string",
        "url": "http://example.com"
      }
    }
  ],
  "meta": {
    "total": -9007199254740991,
    "limit": -9007199254740991,
    "offset": -9007199254740991,
    "datasetVersion": "string"
  }
}

{
  "type": "http://example.com",
  "title": "string",
  "status": -9007199254740991,
  "code": "string",
  "detail": "string",
  "instance": "string",
  "errors": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}

{
  "type": "http://example.com",
  "title": "string",
  "status": -9007199254740991,
  "code": "string",
  "detail": "string",
  "instance": "string",
  "errors": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}

{
  "type": "http://example.com",
  "title": "string",
  "status": -9007199254740991,
  "code": "string",
  "detail": "string",
  "instance": "string",
  "errors": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}

{
  "type": "http://example.com",
  "title": "string",
  "status": -9007199254740991,
  "code": "string",
  "detail": "string",
  "instance": "string",
  "errors": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}

{
  "type": "http://example.com",
  "title": "string",
  "status": -9007199254740991,
  "code": "string",
  "detail": "string",
  "instance": "string",
  "errors": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}