HProxy Service notices API

openapi: 3.2.0
info:
  title: HProxy Service notices API
  version: 1.0.0
  description: 'Buy and manage proxies from a prepaid wallet, run the Scraper API, or use the free no-key APIs: a live proxy list, a proxy checker and an IP lookup. JSON in, JSON out. Money is always integer cents (120 = $1.20), never floats.'
  contact:
    url: https://hproxy.com/contact
  license:
    name: Proprietary
servers:
- url: https://hproxy.com
  description: Production
security:
- ApiKeyAuth: []
tags:
- name: Service notices
paths:
  /api/v1/announcements:
    get:
      operationId: announcements
      summary: List live notices
      description: 'Every published notice addressed to an audience your account belongs to, newest first, at most 50. Accepts **any** valid key (no scope needed). Poll it once an hour at most: it is not a queue, and nothing is lost by polling less. Branch on `kind`.'
      tags:
      - Service notices
      parameters:
      - name: kind
        in: query
        required: false
        description: '`INFO`, `MAINTENANCE`, `INCIDENT`, `RELEASE`, `PRICING` or `ACTION_REQUIRED`. Treat `ACTION_REQUIRED` as a ticket: an integration has something to change, usually with a date in the body.'
        schema:
          type: string
      - name: audience
        in: query
        required: false
        description: '`ALL`, `CUSTOMERS`, `PARTNERS` or `DEVELOPERS`. Every account holding an API key is in `DEVELOPERS`, so notices about the API always reach you here.'
        schema:
          type: string
      - name: publishedAt, expiresAt
        in: query
        required: false
        description: The feed is ordered by `publishedAt`. An expired notice (a maintenance window that has passed) drops out on its own; `expiresAt` is `null` while a notice stands.
        schema:
          type: string
      - name: linkHref, linkLabel
        in: query
        required: false
        description: An optional deep link, relative to hproxy.com or absolute. `null` when there is nothing more to read.
        schema:
          type: string
      - name: unread
        in: query
        required: false
        description: Read state belongs to the account and is set from the dashboard, not from this endpoint. A key-only integration sees `true` until someone opens the notice there.
        schema:
          type: boolean
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
              example:
                announcements:
                - id: 1f3c9a7e-…
                  title: 'Order bodies are now strict: unknown fields return 400'
                  body: From 2026-09-03, POST /orders and every other write endpoint refuse a top-level field they do not read with 400 unknown_field. Check your client for fields outside the documented set.
                  kind: ACTION_REQUIRED
                  audience: DEVELOPERS
                  publishedAt: '2026-09-03T18:40:12+00:00'
                  expiresAt: null
                  linkHref: /docs/errors
                  linkLabel: Errors
                  unread: true
        '400':
          description: Invalid input. The body names the field and the accepted set.
        '401':
          description: Missing or invalid API key.
        '429':
          description: Rate limited. Retry after the delay in the response.
      security:
      - ApiKeyAuth: []
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: Your API key. Free keyless endpoints ignore it.
x-endpoint-count: 163
x-generated-from: https://hproxy.com/docs
x-llms: https://hproxy.com/llms-full.txt