api-ninjas-com SWIFT Code API

openapi: 3.2.0
info:
  title: Ninjas SWIFT Code 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: SWIFT Code
  description: The SWIFT Code API allows you to find the SWIFT (also known as BIC or Business Identifier Code) for any bank in the world. Our database contains hundreds of thousands of different bank branches on file.
paths:
  /v1/swiftcode:
    get:
      summary: Find SWIFT Codes
      description: Returns a list of bank information (including SWIFT/BIC Code) that match the input parameter. Returns at most 100 results. For more results, use the offset parameter.
      operationId: findSwiftCodes
      parameters:
      - $ref: '#/components/parameters/swift'
      - $ref: '#/components/parameters/bank'
      - $ref: '#/components/parameters/SwiftCodeOpenapi_city'
      - $ref: '#/components/parameters/SwiftCodeOpenapi_country'
      - $ref: '#/components/parameters/routing_number'
      - $ref: '#/components/parameters/SwiftCodeOpenapi_offset'
      responses:
        '200':
          description: A list of bank information including SWIFT/BIC codes.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SwiftCodeOpenapi_BankInfo'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SwiftCodeOpenapi_ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SwiftCodeOpenapi_ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SwiftCodeOpenapi_ErrorResponse'
      security:
      - ApiKeyAuth: []
      tags:
      - SWIFT Code
components:
  parameters:
    SwiftCodeOpenapi_country:
      in: query
      name: country
      schema:
        type: string
      description: ISO 3166 2-letter country code of the bank's country.
      required: false
    routing_number:
      name: routing_number
      in: query
      description: 9-digit US ABA routing number. Returns the SWIFT/BIC codes of the US bank identified by the routing number. Available for Business and Professional subscribers only.
      required: false
      schema:
        type: string
    bank:
      in: query
      name: bank
      schema:
        type: string
      description: The name of the bank to look up. This parameter supports partial matching (e.g., Silicon Valley will match Silicon Valley Bank). Premium only.
      required: false
    swift:
      in: query
      name: swift
      schema:
        type: string
      description: The SWIFT Code of the bank to look up.
      required: false
    SwiftCodeOpenapi_city:
      in: query
      name: city
      schema:
        type: string
      description: Name of the city in which the bank is located.
      required: false
    SwiftCodeOpenapi_offset:
      in: query
      name: offset
      schema:
        type: integer
        default: 0
      description: The number of results to offset for pagination. Default is 0. Annual premium subscriptions only.
      required: false
  schemas:
    SwiftCodeOpenapi_BankInfo:
      type: object
      properties:
        swift_code:
          type: string
          description: The SWIFT/BIC code for the bank branch.
        bank_name:
          type:
          - string
          - 'null'
          description: The full official name of the bank. Premium only.
        address:
          type:
          - string
          - 'null'
          description: The full street address of the bank branch. Premium only.
        city:
          type:
          - string
          - 'null'
          description: The city where the bank branch is located. Premium only.
        region:
          type:
          - string
          - 'null'
          description: The region where the bank branch is located. For US banks this is the full state name (e.g. New York). Premium only.
        postal_code:
          type:
          - string
          - 'null'
          description: The postal or ZIP code of the bank branch location. Premium only.
        country:
          type: string
          description: The full name of the country where the bank is located.
        country_code:
          type: string
          description: The ISO 3166 2-letter country code.
        is_eu:
          type:
          - boolean
          - 'null'
          description: Whether the country is an EU member state.
        is_eea:
          type:
          - boolean
          - 'null'
          description: Whether the country is in the European Economic Area (the EU plus Iceland, Liechtenstein and Norway).
        is_sepa:
          type:
          - boolean
          - 'null'
          description: 'Whether the country is in the Single Euro Payments Area. SEPA is wider than the EU or the EEA: it also includes Switzerland, the United Kingdom, Monaco, San Marino, Andorra and Vatican City.'
    SwiftCodeOpenapi_ErrorResponse:
      type: object
      properties:
        error:
          type: string
          description: Error message describing the problem.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-Api-Key
externalDocs:
  description: API Ninjas documentation
  url: https://api-ninjas.com/api