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

# List your giveaway codes

> Requires an affiliate API key. Returns every giveaway code issued to you or bought by you, newest first, with whether it is still `available` or already `redeemed`. Status is not filterable: page through the full list and read `status`. The list does not record which codes you have handed out, so track that yourself.



## OpenAPI

````yaml /openapi.yaml get /v1/affiliate/giveaway-codes
openapi: 3.1.0
info:
  title: MyFundedPerps API (Beta)
  version: 1.0.0
  description: >-
    The developer API is in beta. Breaking changes may be introduced at any
    time. Programmatic access to MyFundedPerps paper-trading challenge accounts.
    API trades use the same real order books and simulated execution engine as
    the web trading interface. Every response carries an `X-Request-Id` header
    for support and log correlation.
  contact:
    url: https://myfundedperpetuals.com/contact
servers:
  - url: https://developers.myfundedperpetuals.com
    description: Live
  - url: https://sandbox.myfundedperpetuals.com
    description: Sandbox (test keys and sandbox accounts only)
security:
  - bearerAuth: []
  - bearerAuth: []
    partnerKey: []
tags:
  - name: General
  - name: Authentication
  - name: Accounts
  - name: Markets
  - name: Positions
  - name: Orders
  - name: Fills
  - name: Strategy Orders
  - name: Price Alerts
  - name: Affiliate
paths:
  /v1/affiliate/giveaway-codes:
    get:
      tags:
        - Affiliate
      summary: List your giveaway codes
      description: >-
        Requires an affiliate API key. Returns every giveaway code issued to you
        or bought by you, newest first, with whether it is still `available` or
        already `redeemed`. Status is not filterable: page through the full list
        and read `status`. The list does not record which codes you have handed
        out, so track that yourself.
      operationId: listAffiliateGiveawayCodes
      parameters:
        - name: limit
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 50
        - name: cursor
          in: query
          schema:
            type: string
            maxLength: 1024
      responses:
        '200':
          description: Cursor-paginated giveaway codes.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AffiliateGiveawayCodePage'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/AffiliateNotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  schemas:
    AffiliateGiveawayCodePage:
      type: object
      required:
        - data
        - has_more
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/AffiliateGiveawayCode'
        has_more:
          type: boolean
        next_cursor:
          type: string
    AffiliateGiveawayCode:
      type: object
      required:
        - id
        - code
        - status
        - source
        - reward
        - first_time_redeemers_only
        - account_requirement
        - issued_at
        - redeemed_at
        - redeemed_by_email
      properties:
        id:
          type: string
        code:
          type:
            - string
            - 'null'
          description: >-
            The code to share. Null only on old codes that kept no readable
            copy.
        status:
          type: string
          enum:
            - available
            - redeemed
            - revoked
          description: >-
            Giveaway codes are single-use; `redeemed` codes cannot be used
            again. `revoked` codes were cancelled by the team before anyone
            redeemed them and can no longer be redeemed.
        source:
          type: string
          enum:
            - team
            - tier_reward
            - purchased
          description: >-
            `team` codes were issued by the MyFundedPerps team, `tier_reward`
            codes came with a reward tier, and `purchased` codes you bought.
        reward:
          oneOf:
            - type: object
              required:
                - kind
                - challenge_tier_key
                - model
                - plan
                - size
                - starting_balance
                - profit_split_pct
              properties:
                kind:
                  type: string
                  const: account
                challenge_tier_key:
                  type: string
                model:
                  type: string
                plan:
                  type: string
                size:
                  type: string
                starting_balance:
                  type: number
                  description: USD.
                profit_split_pct:
                  type: number
            - type: object
              required:
                - kind
                - case_type
              properties:
                kind:
                  type: string
                  const: case
                case_type:
                  type: string
        first_time_redeemers_only:
          type: boolean
          description: Only someone who has never redeemed a code can use it.
        account_requirement:
          type:
            - string
            - 'null'
          enum:
            - without_account
            - with_account
            - null
          description: >-
            Whether the redeemer must have, or must not have, a live account.
            Null means anyone.
        issued_at:
          type: number
          description: Unix timestamp in milliseconds.
        redeemed_at:
          type:
            - number
            - 'null'
          description: When the code was redeemed; null while `available`.
        redeemed_by_email:
          type:
            - string
            - 'null'
          description: >-
            The redeemer's email, partly masked (for example `fo•••@e•••.com`);
            null while `available`.
    ErrorEnvelope:
      type: object
      required:
        - error
      properties:
        error:
          $ref: '#/components/schemas/Error'
    Error:
      type: object
      required:
        - code
        - message
        - request_id
      properties:
        code:
          type: string
        message:
          type: string
        request_id:
          type: string
          format: uuid
        details:
          type: array
          description: >-
            Present on request-validation failures, with one entry per invalid
            field so a request can be fixed in one pass.
          items:
            $ref: '#/components/schemas/ValidationIssue'
    ValidationIssue:
      type: object
      required:
        - field
        - issue
      properties:
        field:
          type: string
          description: >-
            Wire name of the offending request field, such as `size` or
            `operations[2].price`. The value `body` refers to the whole payload.
        issue:
          type: string
  responses:
    BadRequest:
      description: >-
        Invalid request. Validation failures list every offending field in
        `error.details`.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/RequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    Unauthorized:
      description: Missing, invalid, or revoked API key, or an invalid partner key.
      headers:
        WWW-Authenticate:
          schema:
            type: string
        X-Request-Id:
          $ref: '#/components/headers/RequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    Forbidden:
      description: The API key is valid but does not allow this operation.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/RequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    AffiliateNotFound:
      description: >-
        The key's owner is not an active affiliate. Affiliate keys stop working
        while an affiliate account is suspended.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/RequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    RateLimited:
      description: >-
        The per-IP request limit, a partner budget, or an account-wide operation
        budget is exhausted.
      headers:
        Retry-After:
          $ref: '#/components/headers/RetryAfter'
        X-RateLimit-Limit:
          $ref: '#/components/headers/RateLimitLimit'
        X-RateLimit-Scope:
          $ref: '#/components/headers/RateLimitScope'
        X-Request-Id:
          $ref: '#/components/headers/RequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
  headers:
    RequestId:
      description: Stable identifier for support and log correlation.
      schema:
        type: string
        format: uuid
    RetryAfter:
      description: Seconds to wait before retrying.
      schema:
        type: integer
        minimum: 1
    RateLimitLimit:
      description: >-
        Requests per minute allowed by the request budget that ran out. Sent on
        request-budget 429s; account-wide operation budget 429s omit it.
      schema:
        type: integer
        minimum: 1
    RateLimitScope:
      description: >-
        Which request budget ran out: `ip` for the per-address limit, `api_key`
        for a partner's per-trader-key budget, or `partner` for a partner's
        combined budget. Sent on request-budget 429s; account-wide operation
        budget 429s omit it.
      schema:
        type: string
        enum:
          - ip
          - api_key
          - partner
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: MyFundedPerps API key
      description: >-
        API key beginning with `fp_live_` (live keys, served at
        developers.myfundedperpetuals.com) or `fp_test_` (test keys, served at
        sandbox.myfundedperpetuals.com). A key presented on the other host is
        rejected with `401` and a message naming the correct host. Affiliate API
        keys are `fp_live_` keys created on the Affiliates page: they read only
        the `/v1/affiliate` endpoints and get `403` with code
        `insufficient_scope` on every other authenticated endpoint. Every other
        key gets the same `403` on `/v1/affiliate`.
    partnerKey:
      type: apiKey
      in: header
      name: X-MFP-Partner-Key
      description: >-
        Optional partner key beginning with `mfp_partner_`, issued by
        MyFundedPerps to platforms that call the live API on behalf of many
        traders. Send it beside the trader's own `fp_live_` key: the request is
        then counted against the partner's budgets instead of the per-address
        limit. It grants no access on its own. An unknown, malformed, or revoked
        partner key returns `401` with code `invalid_partner_key`. The header is
        ignored on the sandbox host and on requests without a live trader key.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.