api-ninjas-com BSB API

openapi: 3.2.0
info:
  title: Ninjas BSB API
  description: 'Combined OpenAPI specification for every API Ninjas endpoint. Requests go to https://api.api-ninjas.com with an `X-Api-Key` header; get a free key at https://api-ninjas.com/register. Human-readable docs: https://api-ninjas.com/api. Index for LLMs: https://api-ninjas.com/llms.txt.'
  version: 1.0.0
  contact:
    name: API Ninjas
    url: https://api-ninjas.com
  license:
    name: Proprietary
servers:
- url: https://api.api-ninjas.com
  description: API Ninjas Production
security:
- ApiKeyAuth: []
tags:
- name: BSB
  description: The BSB API is a comprehensive BSB lookup and BSB checker tool. Validate any 6-digit Australian BSB number and retrieve the associated bank, branch, address, and supported payment systems.
paths:
  /v1/bsblookup:
    get:
      summary: Get Australian Bank Branch Information by BSB Number
      description: Looks up the bank, branch, address and supported payment systems for a 6-digit Australian BSB number. Requires `bsb`. To find a BSB by bank or location use /bsbsearch.
      operationId: getBsbInfo
      tags:
      - BSB
      parameters:
      - name: bsb
        in: query
        description: The 6-digit Australian BSB number, with or without a hyphen (e.g. 062-000 or 062000).
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/BranchInfo'
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '500':
          description: Internal Server Error
      security:
      - ApiKeyAuth: []
  /v1/bsbsearch:
    get:
      summary: Search for Australian Bank Branches and BSB Numbers
      description: Finds Australian bank branches and their BSB numbers by bank name, suburb, state or postcode. To look up a single BSB number already known use /bsblookup.
      operationId: searchBsb
      tags:
      - BSB
      parameters:
      - name: bank_name
        in: query
        description: Bank name to search for. At least one of bank_name, suburb, state, or postcode is required. Premium only.
        required: false
        schema:
          type: string
      - name: suburb
        in: query
        description: Suburb to search for branches. Premium only.
        required: false
        schema:
          type: string
      - name: state
        in: query
        description: Australian state or territory code (e.g. NSW, VIC, QLD). Premium only.
        required: false
        schema:
          type: string
      - name: postcode
        in: query
        description: 4-digit Australian postcode to search for branches. Premium only.
        required: false
        schema:
          type: string
      - name: offset
        in: query
        description: Number of results to offset for pagination. Available for annual subscriptions only.
        required: false
        schema:
          type: integer
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/BranchInfo'
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '500':
          description: Internal Server Error
      security:
      - ApiKeyAuth: []
components:
  schemas:
    BranchInfo:
      type: object
      properties:
        bank_name:
          type:
          - string
          - 'null'
          description: The name of the bank. Premium only.
        bsb:
          type: string
          description: The 6-digit BSB number, hyphenated.
        branch_name:
          type:
          - string
          - 'null'
          description: The name of the branch. Premium only.
        street_address:
          type:
          - string
          - 'null'
          description: The street address of the branch. Premium only.
        suburb:
          type: string
          description: The suburb of the branch.
        state:
          type: string
          description: The Australian state or territory code (e.g. NSW, VIC, QLD).
        postcode:
          type: string
          description: The 4-digit Australian postcode of the branch.
        country:
          type: string
          description: Always AU.
        phone_number:
          type:
          - string
          - 'null'
          description: The customer service phone number of the bank. Premium only.
        direct_entry_supported:
          type: boolean
          description: Whether the branch supports Direct Entry (DE) payments - the Australian equivalent of ACH. Premium only.
        rtgs_supported:
          type: boolean
          description: Whether the branch supports RTGS (Real-Time Gross Settlement) wire transfers via RITS. Premium only.
        npp_supported:
          type: boolean
          description: Whether the branch supports the New Payments Platform (NPP) for instant payments and PayID. Premium only.
        swift_code:
          type:
          - string
          - 'null'
          description: The SWIFT/BIC code of the bank, useful for international wire transfers. Premium only.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-Api-Key
externalDocs:
  description: API Ninjas documentation
  url: https://api-ninjas.com/api