fourzerotwo-si Nhs Organisations API

openapi: 3.2.0
info:
  title: Fourzerotwo Si Nhs Organisations API
  version: 1.1.0
  contact:
    url: https://fourzerotwo.si
  description: 'Operations tagged nhs-organisations across 2 of this provider''s published API definitions: openapi.json, fourzerotwo-si-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://fourzerotwo.si
tags:
- name: nhs-organisations
  description: 'NHS Organisations (ODS): Every NHS organisation and site: GP practices, pharmacies, trusts, ICBs, dental and optical practices, with codes, roles, addresses and relationships.'
paths:
  /v1/nhs-organisations/organisation:
    get:
      operationId: nhs_organisations__organisation
      summary: 'NHS Organisations (ODS): Organisation by ODS code'
      description: 'Name, status, address, phone/website, roles and relationships (commissioner, operator, geography) for one ODS code. Price: $0.001 USDC per call via x402. Free within the daily allowance with a free key.'
      tags:
      - nhs-organisations
      externalDocs:
        url: https://fourzerotwo.si/apis/nhs-organisations/organisation
      parameters:
      - name: code
        in: query
        required: true
        description: ODS code, e.g. RVV (trust) or G82052 (GP practice)
        schema:
          type: string
          maxLength: 10
        example: G82052
      responses:
        '200':
          description: The data (paid, or free tier).
          content:
            application/json: {}
        '402':
          $ref: '#/components/responses/PaymentRequired'
        '400':
          $ref: '#/components/responses/Error'
        '404':
          $ref: '#/components/responses/Error'
        '502':
          $ref: '#/components/responses/Error'
      security:
      - {}
      - freeKey: []
      x-price-usd: '0.001000'
      x-free-tier: free
      x-mcp-tool: nhs-organisations__organisation
    servers:
    - url: https://fourzerotwo.si
  /v1/nhs-organisations/search:
    get:
      operationId: nhs_organisations__search
      summary: 'NHS Organisations (ODS): Search organisations'
      description: 'Find NHS organisations by name, postcode (or district) and role: gp, pharmacy, trust, trust-site, icb, dental, optical, care-home, hospice, or a role code. Price: $0.001 USDC per call via x402. Free within the daily allowance with a free key.'
      tags:
      - nhs-organisations
      externalDocs:
        url: https://fourzerotwo.si/apis/nhs-organisations/search
      parameters:
      - name: name
        in: query
        required: false
        description: Name contains
        schema:
          type: string
          maxLength: 100
      - name: postcode
        in: query
        required: false
        description: Postcode or district, e.g. CT9
        schema:
          type: string
          maxLength: 8
        example: CT9
      - name: role
        in: query
        required: false
        description: gp | pharmacy | trust | trust-site | icb | dental | optical | care-home | hospice | RO code
        schema:
          type: string
          maxLength: 12
        example: gp
      - name: status
        in: query
        required: false
        description: active (default) | inactive | any
        schema:
          type: string
          maxLength: 8
      - name: limit
        in: query
        required: false
        description: Max results (default 20, max 100)
        schema:
          type: integer
        example: 10
      responses:
        '200':
          description: The data (paid, or free tier).
          content:
            application/json: {}
        '402':
          $ref: '#/components/responses/PaymentRequired'
        '400':
          $ref: '#/components/responses/Error'
        '404':
          $ref: '#/components/responses/Error'
        '502':
          $ref: '#/components/responses/Error'
      security:
      - {}
      - freeKey: []
      x-price-usd: '0.001000'
      x-free-tier: free
      x-mcp-tool: nhs-organisations__search
    servers:
    - url: https://fourzerotwo.si
  /v1/nhs-organisations/roles:
    get:
      operationId: nhs_organisations__roles
      summary: 'NHS Organisations (ODS): Role codes'
      description: 'Every ODS role code with its name, and the friendly aliases search accepts. Price: $0.0005 USDC per call via x402. Free within the daily allowance with a free key.'
      tags:
      - nhs-organisations
      externalDocs:
        url: https://fourzerotwo.si/apis/nhs-organisations/roles
      responses:
        '200':
          description: The data (paid, or free tier).
          content:
            application/json: {}
        '402':
          $ref: '#/components/responses/PaymentRequired'
        '400':
          $ref: '#/components/responses/Error'
        '404':
          $ref: '#/components/responses/Error'
        '502':
          $ref: '#/components/responses/Error'
      security:
      - {}
      - freeKey: []
      x-price-usd: '0.000500'
      x-free-tier: free
      x-mcp-tool: nhs-organisations__roles
    servers:
    - url: https://fourzerotwo.si
components:
  responses:
    PaymentRequired:
      description: x402 payment required. The body (also base64 in the PAYMENT-REQUIRED header) lists accepted payments.
      headers:
        PAYMENT-REQUIRED:
          schema:
            type: string
          description: Base64 JSON x402 v2 PaymentRequired
      content:
        application/json:
          schema:
            type: object
            properties:
              x402Version:
                type: integer
              error:
                type: string
              accepts:
                type: array
                items:
                  type: object
    Error:
      description: 400 = invalid input, 404 = not found at the source, 502 = the source failed. Never charged.
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
              charged:
                type: boolean
  securitySchemes:
    freeKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: Optional free key (fzt_…) for the free tier.
x-refined-from:
- openapi.json
- fourzerotwo-si-openapi.json