HoneyGate API

openapi: 3.1.0
info:
  title: HoneyGate API
  version: '2026-11-11'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-11-11: 15 operation(s) read from 1 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; HoneyGate has published no machine-readable contract that the
    pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 3
    documentation: 12
    pages-with-code: 1
    pages-read: 1
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-11-11'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://honeygate.app/docs/for-developers/rest-api
paths:
  /api/v1/public-api/holdings:
    get:
      operationId: get_api_v1_public_api_holdings
      tags:
      - Api
      summary: GET /api/v1/public-api/holdings
      x-source: https://honeygate.app/docs/for-developers/rest-api
      parameters:
      - name: discord_id
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl \"https://honeygate.app/api/v1/public-api/holdings?discord_id=DISCORD_ID\"  -H \"Authorization: Bearer $HONEY_GATE_API_KEY\"\
          \ \n GET /holder-snapshot?asset_id=…&min_count=… (scope: snapshots.read ) \n Returns the wallet address and whole NFT count for every\
          \ holder meeting min_count in one of your server's tracked NFT collections. asset_id is the tracked asset's short ID. min_count defaults\
          \ to 1 and "
  /api/v1/public-api/leaderboard:
    get:
      operationId: get_api_v1_public_api_leaderboard
      tags:
      - Api
      summary: GET /api/v1/public-api/leaderboard
      x-source: https://honeygate.app/docs/for-developers/rest-api
      parameters:
      - name: limit
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl https://honeygate.app/api/v1/public-api/leaderboard?limit=10  -H \"Authorization: Bearer $HONEY_GATE_API_KEY\" \n Awarding\
          \ Coins: "
  /api/v1/public-api/points-award:
    post:
      operationId: post_api_v1_public_api_points_award
      tags:
      - Api
      summary: POST /api/v1/public-api/points-award
      x-source: https://honeygate.app/docs/for-developers/rest-api
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiV1PublicApiPointsAwardRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X POST https://honeygate.app/api/v1/public-api/points-award  -H \"Authorization: Bearer $HONEY_GATE_API_KEY\"  -H \"Content-Type:\
          \ application/json\"  -d '{\"discord_id\":\"123456789012345678\",\"amount\":250,\"idempotency_key\":\"play-abc123\",\"source\":\"arcade_win\"\
          }' \n Want live updates instead of polling? \n For push-style integration, reach for Outbound webhooks . HoneyGate calls your URL when\
          \ things hap"
  /audit:
    get:
      operationId: get_audit
      tags:
      - Audit
      summary: 'Audit-log entries: role grants and revokes, gate passes, config changes.'
      x-source: https://honeygate.app/docs/for-developers/rest-api
      parameters:
      - name: limit
        in: query
        required: false
        schema:
          type: string
        description: default 100, max 500
      - name: since
        in: query
        required: false
        schema:
          type: string
        description: ISO datetime, defaults to the last 7 days
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /gates:
    get:
      operationId: get_gates
      tags:
      - Gates
      summary: Lists the server's gates, each with its role, logic mode (AND/OR), and conditions.
      x-source: https://honeygate.app/docs/for-developers/rest-api
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /holder-snapshot:
    get:
      operationId: get_holder_snapshot
      tags:
      - Holder Snapshot
      summary: Returns the wallet address and whole NFT count for every holder meeting min_count in one of your server's tracked NFT collections.
      x-source: https://honeygate.app/docs/for-developers/rest-api
      parameters:
      - name: asset_id
        in: query
        required: true
        schema:
          type: string
        description: Tracked asset's short ID
      - name: min_count
        in: query
        required: false
        schema:
          type: string
        description: Defaults to 1
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /holdings:
    get:
      operationId: get_holdings
      tags:
      - Holdings
      summary: How much of your server's tracked assets a member holds on-chain.
      x-source: https://honeygate.app/docs/for-developers/rest-api
      parameters:
      - name: discord_id
        in: query
        required: true
        schema:
          type: string
        description: Discord ID of the member
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /leaderboard:
    get:
      operationId: get_leaderboard
      tags:
      - Leaderboard
      summary: Top members by XP.
      x-source: https://honeygate.app/docs/for-developers/rest-api
      parameters:
      - name: limit
        in: query
        required: false
        schema:
          type: string
        description: default 25, max 500
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /member:
    get:
      operationId: get_member
      tags:
      - Member
      summary: Looks up one member instead of paging through everyone.
      x-source: https://honeygate.app/docs/for-developers/rest-api
      parameters:
      - name: discord_id
        in: query
        required: true
        schema:
          type: string
        description: Discord ID of the member
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /members:
    get:
      operationId: get_members
      tags:
      - Members
      summary: Lists members with discord_id , username, display name, joined_at , left_at , is_bot , and xp .
      x-source: https://honeygate.app/docs/for-developers/rest-api
      parameters:
      - name: limit
        in: query
        required: false
        schema:
          type: string
        description: default 100, max 1000
      - name: offset
        in: query
        required: false
        schema:
          type: string
        description: paging offset
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /points-award:
    post:
      operationId: post_points_award
      tags:
      - Points Award
      summary: Awards Coins to a member.
      x-source: https://honeygate.app/docs/for-developers/rest-api
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostPointsAwardRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /points-balance:
    get:
      operationId: get_points_balance
      tags:
      - Points Balance
      summary: Returns one member's authoritative spendable balance for the API key's server, plus that server's configured currency name and
        abbreviation.
      x-source: https://honeygate.app/docs/for-developers/rest-api
      parameters:
      - name: discord_id
        in: query
        required: true
        schema:
          type: string
        description: Discord ID of the member
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /points-history:
    get:
      operationId: get_points_history
      tags:
      - Points History
      summary: Returns up to 100 of one member's newest ledger entries for the API key's server.
      x-source: https://honeygate.app/docs/for-developers/rest-api
      parameters:
      - name: discord_id
        in: query
        required: true
        schema:
          type: string
        description: Discord ID of the member
      - name: limit
        in: query
        required: false
        schema:
          type: string
        description: Number of entries to return
      - name: before_id
        in: query
        required: false
        schema:
          type: string
        description: Cursor to page backward
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /points-reverse:
    post:
      operationId: post_points_reverse
      tags:
      - Points Reverse
      summary: Creates one exact compensating entry for a prior /points-award.
      x-source: https://honeygate.app/docs/for-developers/rest-api
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostPointsReverseRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /points-spend:
    post:
      operationId: post_points_spend
      tags:
      - Points Spend
      summary: Deducts a positive whole-number amount from one member.
      x-source: https://honeygate.app/docs/for-developers/rest-api
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostPointsSpendRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
components:
  schemas:
    PostApiV1PublicApiPointsAwardRequest:
      type: object
      properties:
        discord_id:
          type: string
        amount:
          type: integer
        idempotency_key:
          type: string
        source:
          type: string
    PostPointsAwardRequest:
      type: object
      properties:
        discord_id:
          type: string
          description: The member's Discord ID. They must be in your server.
        amount:
          type: integer
          description: A whole number above zero, up to 1,000,000 per call.
        idempotency_key:
          type: string
          description: Any string unique to this award.
        source:
          type: string
          description: A short label that shows in the ledger, e.g. arcade_win.
        note:
          type: string
          description: Human‑readable note, up to 500 characters.
      required:
      - discord_id
      - amount
      - idempotency_key
    PostPointsReverseRequest:
      type: object
      properties:
        idempotency_key:
          type: string
          description: Original award's idempotency_key
        reversal_idempotency_key:
          type: string
          description: New idempotency key for the reversal
        reason:
          type: string
          description: Human reason for the reversal
      required:
      - idempotency_key
      - reversal_idempotency_key
      - reason
    PostPointsSpendRequest:
      type: object
      properties:
        discord_id:
          type: string
          description: Member's Discord ID
        amount:
          type: integer
          description: Positive whole-number amount to deduct
        idempotency_key:
          type: string
          description: Unique key for this spend operation
        source:
          type: string
          description: Optional source label
        note:
          type: string
          description: Optional human‑readable note
      required:
      - discord_id
      - amount
      - idempotency_key
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
security:
- bearer: []
tags:
- name: Api
- name: Audit
- name: Gates
- name: Holder Snapshot
- name: Holdings
- name: Leaderboard
- name: Member
- name: Members
- name: Points Award
- name: Points Balance
- name: Points History
- name: Points Reverse
- name: Points Spend