BITHOT Monthlies API

openapi: 3.2.0
info:
  title: BITHOT Public Monthlies API
  version: 5.0.0
  description: 'Anonymous, read-only API for clients and Agents. No API key is required.


    Picking an endpoint: answer a person''s question inside an AI agent -> read /api/v1/agent, which lists Markdown addresses made for agents. Show recent or today''s items -> /api/v1/items. Show what is trending right now -> /api/v1/hot-topics. Show the daily digest -> /api/v1/dailies/latest; the weekly and monthly reports -> /api/v1/weeklies/latest and /api/v1/monthlies/latest. Keep a complete local copy of the selected set -> /api/v1/selected/snapshot once, then /api/v1/selected/changes forever.


    How often to poll: use each response''s Cache-Control s-maxage as the minimum interval, and always send If-None-Match: an unchanged resource answers 304 with an empty body. On 429 or 503, honour Retry-After. There is no push channel (no SSE, webhooks or streaming): poll on an interval.


    Keep responses small: send Accept-Encoding: gzip or br (curl --compressed). To follow new items, page back only until you reach an id you already have instead of re-reading the whole 7-day window on every poll; to keep every selected item, read /api/v1/selected/snapshot once and then only /api/v1/selected/changes.


    Report dates, weeks and months identify fixed editions, but corrections and withdrawn citations can change their public content. Revalidate retained copies with If-None-Match after Cache-Control expires; do not treat a dated report as immutable.


    Titles and summaries are generated from third-party sources; the original is always linked in links.original.'
  termsOfService: https://bithot.news/terms
servers:
- url: https://bithot.news
tags:
- name: Monthlies
paths:
  /api/v1/monthlies:
    get:
      operationId: monthlies
      summary: List monthly reports
      description: 'Index of published monthly reports, newest first: month, its first and last day, headline and BITHOT link. A monthly is published on the 1st of each month at 10:30 Asia/Shanghai, compiled from the dailies dated in that month.'
      parameters:
      - $ref: '#/components/parameters/ActorUserAgent'
      - $ref: '#/components/parameters/IfNoneMatch'
      - name: limit
        in: query
        schema:
          type: integer
          minimum: 1
          maximum: 60
          default: 12
      responses:
        '200':
          description: OK
          headers:
            ETag:
              schema:
                type: string
            Cache-Control:
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MonthliesResponse'
        '304':
          description: Not Modified
          headers:
            ETag:
              schema:
                type: string
            Cache-Control:
              schema:
                type: string
        '400':
          description: Machine-readable problem response.
          headers:
            X-Request-Id:
              description: Support correlation identifier for this failed request.
              schema:
                type: string
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: Machine-readable problem response.
          headers:
            X-Request-Id:
              description: Support correlation identifier for this failed request.
              schema:
                type: string
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: Machine-readable problem response.
          headers:
            X-Request-Id:
              description: Support correlation identifier for this failed request.
              schema:
                type: string
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: Machine-readable problem response.
          headers:
            X-Request-Id:
              description: Support correlation identifier for this failed request.
              schema:
                type: string
            Retry-After:
              description: Minimum number of seconds to wait before retrying.
              schema:
                type: integer
                minimum: 1
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '503':
          description: Machine-readable problem response.
          headers:
            X-Request-Id:
              description: Support correlation identifier for this failed request.
              schema:
                type: string
            Retry-After:
              description: Minimum number of seconds to wait before retrying.
              schema:
                type: integer
                minimum: 1
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
      tags:
      - Monthlies
  /api/v1/monthlies/latest:
    get:
      operationId: latestMonthly
      summary: Get the latest monthly report
      description: 'The most recent monthly report: its headline, overview and the month''s most important items grouped by section, chosen from that month''s dailies. Published on the 1st of each month at 10:30 Asia/Shanghai. Tool runtimes that cache a stable URL should first request /api/v1/monthlies?limit=1 and then /api/v1/monthlies/{returned-month}; never guess a month.'
      responses:
        '200':
          description: OK
          headers:
            ETag:
              schema:
                type: string
            Cache-Control:
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MonthlyResponse'
        '304':
          description: Not Modified
          headers:
            ETag:
              schema:
                type: string
            Cache-Control:
              schema:
                type: string
        '400':
          description: Machine-readable problem response.
          headers:
            X-Request-Id:
              description: Support correlation identifier for this failed request.
              schema:
                type: string
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: Machine-readable problem response.
          headers:
            X-Request-Id:
              description: Support correlation identifier for this failed request.
              schema:
                type: string
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: Machine-readable problem response.
          headers:
            X-Request-Id:
              description: Support correlation identifier for this failed request.
              schema:
                type: string
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: Machine-readable problem response.
          headers:
            X-Request-Id:
              description: Support correlation identifier for this failed request.
              schema:
                type: string
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: Machine-readable problem response.
          headers:
            X-Request-Id:
              description: Support correlation identifier for this failed request.
              schema:
                type: string
            Retry-After:
              description: Minimum number of seconds to wait before retrying.
              schema:
                type: integer
                minimum: 1
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '503':
          description: Machine-readable problem response.
          headers:
            X-Request-Id:
              description: Support correlation identifier for this failed request.
              schema:
                type: string
            Retry-After:
              description: Minimum number of seconds to wait before retrying.
              schema:
                type: integer
                minimum: 1
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
      parameters:
      - $ref: '#/components/parameters/ActorUserAgent'
      - $ref: '#/components/parameters/IfNoneMatch'
      tags:
      - Monthlies
  /api/v1/monthlies/{month}:
    get:
      operationId: monthlyByMonth
      summary: Get a monthly report by month
      description: A single monthly report by calendar month (YYYY-MM, for example 2026-09). Corrections and withdrawn citations can change the public content of this edition. Respect Cache-Control and revalidate with If-None-Match before reusing an expired copy.
      parameters:
      - $ref: '#/components/parameters/ActorUserAgent'
      - $ref: '#/components/parameters/IfNoneMatch'
      - name: month
        in: path
        required: true
        schema:
          type: string
          pattern: ^\d{4}-\d{2}$
        description: Calendar month, e.g. 2026-09.
      responses:
        '200':
          description: OK
          headers:
            ETag:
              schema:
                type: string
            Cache-Control:
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MonthlyResponse'
        '304':
          description: Not Modified
          headers:
            ETag:
              schema:
                type: string
            Cache-Control:
              schema:
                type: string
        '400':
          description: Machine-readable problem response.
          headers:
            X-Request-Id:
              description: Support correlation identifier for this failed request.
              schema:
                type: string
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: Machine-readable problem response.
          headers:
            X-Request-Id:
              description: Support correlation identifier for this failed request.
              schema:
                type: string
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: Machine-readable problem response.
          headers:
            X-Request-Id:
              description: Support correlation identifier for this failed request.
              schema:
                type: string
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: Machine-readable problem response.
          headers:
            X-Request-Id:
              description: Support correlation identifier for this failed request.
              schema:
                type: string
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: Machine-readable problem response.
          headers:
            X-Request-Id:
              description: Support correlation identifier for this failed request.
              schema:
                type: string
            Retry-After:
              description: Minimum number of seconds to wait before retrying.
              schema:
                type: integer
                minimum: 1
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '503':
          description: Machine-readable problem response.
          headers:
            X-Request-Id:
              description: Support correlation identifier for this failed request.
              schema:
                type: string
            Retry-After:
              description: Minimum number of seconds to wait before retrying.
              schema:
                type: integer
                minimum: 1
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
      tags:
      - Monthlies
components:
  schemas:
    MonthlyReport:
      allOf:
      - $ref: '#/components/schemas/PeriodReport'
      - type: object
        required:
        - month
        properties:
          month:
            type: string
            pattern: ^\d{4}-\d{2}$
    MonthliesResponse:
      type: object
      required:
      - schemaVersion
      - count
      - items
      properties:
        schemaVersion:
          const: 1
        count:
          type: integer
          minimum: 0
        items:
          type: array
          items:
            $ref: '#/components/schemas/MonthlyEntry'
    MonthlyEntry:
      allOf:
      - $ref: '#/components/schemas/PeriodEntry'
      - type: object
        required:
        - month
        properties:
          month:
            type: string
            pattern: ^\d{4}-\d{2}$
            description: Calendar month, e.g. 2026-09.
    MonthlyResponse:
      type: object
      required:
      - schemaVersion
      - report
      properties:
        schemaVersion:
          const: 1
        report:
          $ref: '#/components/schemas/MonthlyReport'
    Problem:
      type: object
      required:
      - type
      - title
      - status
      - detail
      - code
      - requestId
      properties:
        type:
          type: string
        title:
          type: string
        status:
          type: integer
        detail:
          type: string
        code:
          type: string
        requestId:
          type: string
    PeriodEntry:
      type: object
      required:
      - periodStart
      - periodEnd
      - generatedAt
      - headline
      - links
      properties:
        periodStart:
          type:
          - string
          - 'null'
          format: date
          description: First calendar day the issue covers (Asia/Shanghai).
        periodEnd:
          type:
          - string
          - 'null'
          format: date
          description: Last calendar day the issue covers (Asia/Shanghai).
        generatedAt:
          type: string
          format: date-time
        headline:
          type:
          - string
          - 'null'
          description: 'The issue''s lead: its most important item''s title, or once that item is withdrawn the next one still public (older issues may carry their own headline).'
        links:
          type: object
          required:
          - aihot
          properties:
            aihot:
              type: string
              format: uri
        attribution:
          $ref: '#/components/schemas/Attribution'
    PeriodReport:
      type: object
      required:
      - periodStart
      - periodEnd
      - generatedAt
      - windowStart
      - windowEnd
      - links
      - headline
      - overview
      - sections
      properties:
        periodStart:
          type:
          - string
          - 'null'
          format: date
        periodEnd:
          type:
          - string
          - 'null'
          format: date
        generatedAt:
          type: string
          format: date-time
        windowStart:
          type: string
          format: date-time
          description: Start of the dailies' windows the issue was compiled from.
        windowEnd:
          type: string
          format: date-time
        links:
          type: object
          required:
          - aihot
          properties:
            aihot:
              type: string
              format: uri
        attribution:
          $ref: '#/components/schemas/Attribution'
        headline:
          type:
          - string
          - 'null'
          description: The most important item's title, or once that item is withdrawn the next one still public (older issues may carry their own headline).
        overview:
          type:
          - string
          - 'null'
          description: A short overview of the period's main threads, written only from the items listed.
        sections:
          type: array
          description: Sections in reading order, each with its items in order of importance. Withdrawn items are left out.
          items:
            type: object
            required:
            - label
            - summary
            - items
            properties:
              label:
                type: string
              summary:
                type:
                - string
                - 'null'
                description: One or two sentences introducing the section, when there is one.
              items:
                type: array
                items:
                  type: object
                  required:
                  - title
                  - summary
                  - source
                  - links
                  - publishedAt
                  properties:
                    title:
                      type: string
                    summary:
                      type: string
                    source:
                      type: object
                      required:
                      - name
                      properties:
                        name:
                          type: string
                    links:
                      $ref: '#/components/schemas/DailyContentLinks'
                    publishedAt:
                      type:
                      - string
                      - 'null'
                      format: date-time
                    attribution:
                      $ref: '#/components/schemas/Attribution'
    Attribution:
      type: object
      description: Machine-readable BITHOT provenance for traceability. Retain it where technically feasible. Attribution alone is not authorization; see the public terms.
      required:
      - name
      - url
      properties:
        name:
          type: string
        url:
          type: string
          format: uri
    DailyContentLinks:
      type: object
      required:
      - aihot
      - original
      properties:
        aihot:
          type:
          - string
          - 'null'
          format: uri
        original:
          type: string
          format: uri
  parameters:
    IfNoneMatch:
      name: If-None-Match
      in: header
      required: false
      description: Previously received ETag for this exact URL. A match returns 304 without a response body.
      schema:
        type: string
    ActorUserAgent:
      name: User-Agent
      in: header
      required: false
      description: The client's normal User-Agent (optional; any value works).
      schema:
        type: string
        maxLength: 2048
      example: my-reader/1.0
externalDocs:
  description: Machine-readable OpenAPI document
  url: https://bithot.news/openapi-v1.json