> ## 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. # Get one of your top-up listings > Any status, including what is left of its stock. A listing filed under another category answers `404`, like one that is not yours. ## OpenAPI ````yaml /openapi.yaml get /v1/offers/top-up/{id} 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/upload-url`, then PUT the bytes to the URL it returns. Repeat per picture, collect the public URLs. 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/top-up/{id}: get: tags: - Top-ups summary: Get one of your top-up listings description: | Any status, including what is left of its stock. A listing filed under another category answers `404`, like one that is not yours. operationId: getTopUpOffer_top_up parameters: - $ref: '#/components/parameters/OfferID' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/TopUpOfferDetail' '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' components: parameters: OfferID: name: id in: path required: true schema: type: string format: uuid schemas: TopUpOfferDetail: allOf: - $ref: '#/components/schemas/TopUpOffer' - $ref: '#/components/schemas/FiledUnder' - $ref: '#/components/schemas/Pool' TopUpOffer: allOf: - $ref: '#/components/schemas/FixedPriceOffer' - type: object properties: delivery_method: type: - string - 'null' description: The key this listing hands over by. delivery_instructions: type: string description: What the buyer is told to do at handover. FiledUnder: type: object description: Which game a listing is under. The category is the path. properties: game_id: type: string format: uuid game_slug: type: string Pool: type: object description: The stock of a listing that sells out of encrypted units. properties: available_units: type: integer format: int64 description: Units neither reserved nor sold. units: type: array description: Your own pool — id and status per unit, never the goods. items: $ref: '#/components/schemas/Unit' 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 FixedPriceOffer: allOf: - $ref: '#/components/schemas/OfferBase' - $ref: '#/components/schemas/Delivery' - type: object properties: price: type: integer format: int64 description: US cents. currency: type: string examples: - USD description: Always `USD`. images: type: array items: type: string format: uri delivery_type: type: string enum: - instant - manual description: >- `instant` sells out of the unit pool; `manual` you hand over yourself. Unit: type: object properties: id: type: string format: uuid status: type: string enum: - available - reserved - sold - revoked description: | `available` until an order takes it. `revoked` is a unit whose goods reached the buyer and were then refunded — it is wiped, and never sells again. OfferBase: type: object description: What every category's listing carries, whatever it sells. properties: id: type: string format: uuid title: type: string description: type: string attributes: type: object description: The category's own fields, keyed by the schema's `key`. additionalProperties: true tags: type: array items: type: string status: type: string description: | `draft` on create, then `active` once you publish it. `paused` and `archived` are yours too, through pause and `DELETE`. `reserved` and `sold` follow an order. `removed` is a takedown after publishing, which no call in this API performs. enum: - draft - active - paused - reserved - sold - removed - archived created_at: type: - string - 'null' format: date-time updated_at: type: - string - 'null' format: date-time published_at: type: - string - 'null' format: date-time description: | When `publish` put it on the marketplace. `null` while it is a draft, and written once — pausing and unpausing leave it alone. Delivery: type: object description: How a listing sold by hand promises to hand over. properties: manual_delivery_value: type: - integer - 'null' format: int32 description: >- The handover time promised, read together with the unit — `2` and `hours`. manual_delivery_unit: type: - string - 'null' enum: - minutes - hours - days - null description: >- What the value counts. Both are `null` on a listing delivered instantly. responses: Unauthorized: description: | The key is unknown, revoked, or the request came from an address outside the key's list. Which check failed is not disclosed. content: application/json: schema: $ref: '#/components/schemas/Error' examples: unauthorized: value: error: unauthorized 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**. ````