> ## Documentation Index
> Fetch the complete documentation index at: https://docs.nephia.cc/llms.txt
> Use this file to discover all available pages before exploring further.

# List a keyword's buckets

> The buckets a listening keyword sorts its mentions into, with a count each. Use the ids to filter `GET /v1/keywords/{id}/results`. Read-only and free: it never triggers a sorting pass, so listing buckets cannot bill.



## OpenAPI

````yaml /openapi.json get /v1/keywords/{id}/buckets
openapi: 3.1.0
info:
  title: Nephia API
  description: >-
    The brand-monitoring API. Create a **keyword** and it polls the live Sources
    (X, Reddit, Youtube, TikTok, Bluesky, Hacker News, Mastodon, Lemmy, GitHub,
    Product Hunt, Stack Overflow, RSS, AI answers and Vinted) on an interval,
    keeps what matches, reads each mention for sentiment and intent, sorts it
    into your buckets and answers your own agent step over it. Read the result
    back as **mentions** (`GET /v1/mentions` across the whole Account, or per
    keyword), or have it pushed to you as signed webhook events and delivery
    channels. A search can carry several terms at once, OR'd into one upstream
    request at one tick's cost. Authenticate with an API key on your Account.
    Monitoring is sold as a subscription (keywords, terms, freshness and AI)
    with credits as the meter underneath; credit packs are overflow and never
    change a limit. Reading your own mentions is free; the semantic search mode
    and the AI passes are what meter. Request quota is per Account (all API keys
    share one bucket), by Plan: Free 60/min, Solo 350/min, Growth 700/min, Pro
    1200/min.
  version: 1.0.0
servers:
  - url: https://api.nephia.cc
    description: Production
security:
  - ApiKeyAuth: []
tags:
  - name: Account
    description: Account balance
  - name: Mentions
    description: Everything your keywords caught, across every Source
  - name: Keywords
    description: >-
      What you monitor. A keyword carries its terms, its Sources and its
      settings. Read, create, edit and pause them here.
  - name: Explore
    description: >-
      One question asked of the Sources once, priced first, without creating a
      keyword
  - name: AI
    description: Group, classify, agent and summarise passes over items you name
  - name: Vinted analytics
    description: Observed price history and per-day market statistics
paths:
  /v1/keywords/{id}/buckets:
    get:
      tags:
        - Keywords
      summary: List a keyword's buckets
      description: >-
        The buckets a listening keyword sorts its mentions into, with a count
        each. Use the ids to filter `GET /v1/keywords/{id}/results`. Read-only
        and free: it never triggers a sorting pass, so listing buckets cannot
        bill.
      operationId: getV1KeywordsByIdBuckets
      parameters:
        - in: path
          name: id
          schema:
            type: string
            format: uuid
          required: true
      responses:
        '200':
          description: Buckets
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KeywordBucketsResponse'
        '404':
          description: Keyword not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
                required:
                  - error
        '429':
          description: >-
            Request quota exceeded. Retry after the `Retry-After` header
            (seconds). Response includes `RateLimit-*` headers (IETF draft-7).
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
                required:
                  - error
              example:
                error: Rate limit exceeded
                code: TOO_MANY_REQUESTS
components:
  schemas:
    KeywordBucketsResponse:
      type: object
      properties:
        kind:
          type: string
          enum:
            - catalog
            - listening
        since:
          type: string
        buckets:
          type: array
          items:
            $ref: '#/components/schemas/KeywordBucket'
        unclassifiedCount:
          type: number
        pendingCount:
          type: number
      required:
        - kind
        - since
        - buckets
        - unclassifiedCount
        - pendingCount
    KeywordBucket:
      type: object
      properties:
        id:
          type: string
        label:
          type: string
        rule:
          type: string
        color:
          type: string
        origin:
          type: string
        count:
          type: number
        createdAt:
          type: string
      required:
        - id
        - label
        - rule
        - color
        - origin
        - count
        - createdAt
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: API key created from the Nephia dashboard for your Account.

````