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

# What this category needs

> The one call to make before building a create body: `attributes[]` is
the category's field list, and `version` is what a listing created now
is pinned to. What else a body must carry is the category's own create
page — each category takes only its own fields.




## OpenAPI

````yaml /openapi.yaml get /v1/offers/games/{game}/categories/{category_slug}/schema
openapi: 3.1.0
info:
  title: MoonUP Seller API
  version: 1.0.0
  summary: List and manage your offers from your own tools.
  description: |
    Everything a seller's bot needs to keep a catalogue of listings up to date:
    create a listing, restock it, pause it, archive it.

    Each category has its own paths — `/v1/offers/accounts`,
    `/v1/offers/currency` and so on — with its own fields. You integrate with
    the categories you sell in, and a category added to the platform later
    leaves yours untouched.

    This is the public surface. The cabinet's own screens — payouts, disputes,
    account settings — are not part of it and an API key does not reach them.

    ## Authentication

    Create a key in the cabinet under **Seller → API keys**. It is shown once.
    Send it on every request:

    ```
    Authorization: Bearer moonup_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
    ```

    There is nothing to exchange it for — no short-lived token sits in between.
    HTTPS only. Keep the key in an environment variable or your CI's secret
    store, never in a repository.

    A key may be pinned to a list of addresses when you create it (up to 16
    addresses or subnets). An empty list means any address.

    ## Creating a listing

    Categories do not sell the same thing, so they do not ask for the same
    fields, and each one's create call takes only its own. An accounts listing
    has a price and a picture; a currency listing has a product, a price per
    unit and a stock, and no picture at all; a gift card is a code, so it has
    no manual handover time to promise.

    What every category does share is `attributes` — its own field list, which
    varies by game and is versioned. That one you read at runtime:

        GET /v1/offers/games/{game}/categories/{category_slug}/schema

    A full pass looks like this:

    1. `GET /v1/offers/games` — pick a game, keep its `slug`.
    2. `GET /v1/offers/games/{game}/categories` — pick a category.
    3. `GET /v1/offers/games/{game}/categories/{category_slug}/schema` — read
       `attributes`.
    4. `POST /v1/offers/images` with the picture as the body. Repeat per
       picture, collect the `image_url`s. Skip it for a category with no
       gallery.
    5. `POST /v1/offers/{category}` — the listing is created as a `draft`.
    6. `POST /v1/offers/{category}/{id}/publish` — it goes on the marketplace.

    ## Statuses

    A new listing is a `draft`: yours, and nobody else's to see. `publish`
    makes it `active`, and buyers can buy it from that moment — nothing reviews
    it first. Editing changes nothing about where a listing stands: an `active`
    one stays live, a `draft` stays a draft.

    `paused` is yours too, through pause and unpause. `archived` is the end of
    the line: `DELETE` retires a listing for good and keeps it readable to you.
    `reserved` and `sold` follow orders, not calls. `removed` is a takedown
    after the fact, which no call in this API performs.

    ## Rate limits

    | | Budget |
    |---|---|
    | Reads | 500 requests per minute |
    | Writes | 250 requests per minute |
    | Writes to one offer | 5 per minute and 10 per hour |

    Going over answers `429`. It is temporary: wait and retry, the key stays
    valid. Up to 5 keys per account — create the second one ahead of time so
    you can rotate without downtime.

    ## Errors

    Every failure answers with the same body, a stable snake_case code:

    ```json
    { "error": "delivery_instructions_required" }
    ```

    Branch on `error`, not on the message — there is no message.
servers:
  - url: https://api.moonup.gg
    description: Production
security:
  - api_key: []
tags:
  - name: Catalog
    description: |
      What can be listed, and what each category's fields are. Public: these
      read without a key, so you can explore before you have one.
  - name: Accounts
    description: Game accounts, sold whole — one price, one picture.
  - name: Top-ups
    description: Top-up packs, handed over by one of the platform's delivery methods.
  - name: Gift cards
    description: Fixed-denomination codes, handed over instantly.
  - name: Currency
    description: In-game currency, priced per unit out of a stock you keep.
  - name: Pictures
    description: Where an offer's images come from.
paths:
  /v1/offers/games/{game}/categories/{category_slug}/schema:
    get:
      tags:
        - Catalog
      summary: What this category needs
      description: |
        The one call to make before building a create body: `attributes[]` is
        the category's field list, and `version` is what a listing created now
        is pinned to. What else a body must carry is the category's own create
        page — each category takes only its own fields.
      parameters:
        - $ref: '#/components/parameters/Game'
        - $ref: '#/components/parameters/CategorySlug'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CategorySchema'
              examples:
                accounts:
                  summary: An accounts category — a picture, a price, either delivery
                  value:
                    id: 018f2c1e-0000-7000-8000-000000000001
                    game_category_id: 018f2c1e-0000-7000-8000-000000000002
                    version: 1
                    attributes:
                      - key: more_played_game
                        label: Most Played Game
                        type: enum
                        required: true
                        filterable: true
                        enum_values:
                          - Blox Fruits
                          - Adopt Me!
                      - key: robux_balance
                        label: Robux Balance
                        type: number
                        required: false
                        filterable: false
                        min: 0
                currency:
                  summary: >-
                    A currency category — priced per unit out of a stock, manual
                    only
                  value:
                    id: 018f2c1e-0000-7000-8000-000000000003
                    game_category_id: 018f2c1e-0000-7000-8000-000000000004
                    version: 2
                    attributes: []
        '404':
          $ref: '#/components/responses/NotFound'
      security: []
components:
  parameters:
    Game:
      name: game
      in: path
      required: true
      description: The game's `slug`, or its id — both are accepted.
      schema:
        type: string
        examples:
          - roblox
    CategorySlug:
      name: category_slug
      in: path
      required: true
      schema:
        type: string
        examples:
          - accounts
  schemas:
    CategorySchema:
      type: object
      description: A category's fields, and what its create call demands.
      properties:
        id:
          type: string
          format: uuid
        game_category_id:
          type: string
          format: uuid
        version:
          type: integer
          description: The schema version a listing created now is pinned to.
        attributes:
          type: array
          items:
            $ref: '#/components/schemas/SchemaField'
        created_at:
          type:
            - string
            - 'null'
          format: date-time
    SchemaField:
      type: object
      description: One field of a category's attribute schema.
      properties:
        key:
          type: string
        label:
          type: string
        type:
          type: string
          enum:
            - string
            - number
            - boolean
            - enum
            - reference
            - password
        required:
          type: boolean
        filterable:
          type: boolean
          description: The storefront offers this field as a filter.
        multiple:
          type: boolean
          description: The value is then an array of what `type` describes.
        enum_values:
          type: array
          items:
            type: string
          description: Allowed values, for `enum`.
        catalog_key:
          type: string
          description: |
            For `reference` — which catalog to read the allowed ids from, at
            `GET /v1/offers/games/{game_id}/catalog/{attribute_key}`. Equal to
            `key` when absent.
        min:
          type: number
          description: For `number` — the smallest value accepted.
        max:
          type: number
          description: For `number` — the largest.
      required:
        - key
        - label
        - type
        - required
        - filterable
    Error:
      type: object
      description: The one failure shape this API answers with.
      properties:
        error:
          type: string
          description: A stable snake_case code. Branch on this.
          examples:
            - delivery_instructions_required
      required:
        - error
  responses:
    NotFound:
      description: >-
        No such thing — or none you may know about, which answers the same on
        purpose.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            not_found:
              value:
                error: not_found
  securitySchemes:
    api_key:
      type: http
      scheme: bearer
      description: Your API key, from the cabinet under **Seller → API keys**.

````