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

# Get the caller's StockBack/Cashback promo status

> **Rate limit:** 60 requests per 60 seconds. This is the **default shared quota** — it is shared with every other endpoint that has no dedicated limit, so requests across those endpoints all draw from the same budget.

---

Returns the calling customer's current StockBack/Cashback promo enrollment and lifetime USD reward figures - opted-in status, selected stock, professional-investor status, reward channel, club tier, country, this month's expected reward, and lifetime StockBack/Cashback/total USD earned. This is user-scoped: the caller is identified by their own gateway-issued GCID, not a path or query parameter, so it always answers for 'me'. A customer who is not (or not yet) enrolled in the promo still returns 200, with every value field null, rather than 404 - a 404 means no row exists for this GCID at all, which is a data-completeness gap, not simply 'not enrolled'.



## OpenAPI

````yaml /api-reference/openapi.json get /api/v1/data/stockback/promo-status
openapi: 3.0.1
info:
  title: eToro Api
  version: v1.375.0
  description: >-
    eToro’s public API provides access to real-time financial data, trading
    insights, and account management features, allowing developers to integrate
    eToro’s services into their applications. With access to market prices,
    historical data, and social trading information, the API empowers users to
    enhance their trading strategies. Designed for security and scalability, the
    eToro API ensures smooth and reliable integration for a variety of financial
    applications.


    For more details on integrating with eToro's public WebSocket service,
    please refer to the dedicated [WebSocket
    documentation](./websocket/websocket-doc.html).


    ## Authentication


    Every request must be authenticated with exactly one of two options: an
    OAuth 2.0 access token (`Authorization: Bearer <token>`), or the
    non-interactive credential pair (`x-api-key` + `x-user-key` headers). The
    two options are mutually exclusive — a request carrying both is rejected.
    Each operation lists the OAuth scopes that grant access as alternative
    security requirements: a bearer token needs only ONE of them, and the same
    permissions govern the credential pair.
servers:
  - url: https://public-api.etoro.com
    description: eToro Public API
security:
  - apiKeyAuth: []
    userKeyAuth: []
  - oauth2: []
tags:
  - name: Agent Portfolios
  - name: Social Feeds
  - name: Balances
  - name: Clubs
  - name: Watchlists
  - name: Data
  - name: Top Assets
  - name: App Data
  - name: Market Data
  - name: Identity
  - name: Cash Accounts
  - name: Transfer
  - name: Notifications
  - name: PI Data
  - name: PortfolioSearch
  - name: Price Alerts
  - name: SSO - Applications
  - name: SSO - Scopes
  - name: Sub-Accounts - eToro Trading
  - name: Sub-Accounts
  - name: Trading - Demo
  - name: Trading - Real
  - name: Users Info
  - name: Rankings
  - name: User Stats
  - name: Copy Trading
  - name: Copy Trading - Demo
paths:
  /api/v1/data/stockback/promo-status:
    get:
      tags:
        - Data
      summary: Get the caller's StockBack/Cashback promo status
      description: >-
        **Rate limit:** 60 requests per 60 seconds. This is the **default shared
        quota** — it is shared with every other endpoint that has no dedicated
        limit, so requests across those endpoints all draw from the same budget.


        ---


        Returns the calling customer's current StockBack/Cashback promo
        enrollment and lifetime USD reward figures - opted-in status, selected
        stock, professional-investor status, reward channel, club tier, country,
        this month's expected reward, and lifetime StockBack/Cashback/total USD
        earned. This is user-scoped: the caller is identified by their own
        gateway-issued GCID, not a path or query parameter, so it always answers
        for 'me'. A customer who is not (or not yet) enrolled in the promo still
        returns 200, with every value field null, rather than 404 - a 404 means
        no row exists for this GCID at all, which is a data-completeness gap,
        not simply 'not enrolled'.
      operationId: getStockbackPromoStatus
      parameters:
        - name: x-request-id
          in: header
          required: true
          schema:
            type: string
            format: uuid
            example: dcce8e27-c2c5-43da-b669-a499ec37ecdb
          description: A unique request identifier.
          example: dcce8e27-c2c5-43da-b669-a499ec37ecdb
      responses:
        '200':
          description: The caller's current StockBack/Cashback promo status.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StockbackPromoStatus'
              example:
                isOptedIn: true
                selectedStock: AAPL
                currentIsPi: false
                rewardChannel: stockback
                currentClub: Silver
                currentCountry: GB
                expectedCurrentMonthUsd: 12.34
                stockbackLifetimeUsd: 100.5
                cashbackLifetimeUsd: 50.25
                totalLifetimeUsd: 150.75
          headers:
            RateLimit-Limit:
              description: >-
                Maximum number of requests allowed per window. This is the
                default shared pool used by every endpoint without a dedicated
                limit, so it is NOT per-endpoint — requests across those
                endpoints all draw from this one budget.
              schema:
                type: integer
              example: 60
            RateLimit-Remaining:
              description: Requests remaining in the current window for this quota.
              schema:
                type: integer
            RateLimit-Reset:
              description: Seconds until the current window resets.
              schema:
                type: integer
            RateLimit-Policy:
              description: Quota policy in the form `<limit>;w=<window-seconds>`.
              schema:
                type: string
              example: 60;w=60
        '401':
          description: The gateway did not inject a GCID for this request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataApiError'
              example:
                error:
                  code: gcid_required
                  message: This endpoint requires a gateway-issued GCID
                requestId: 3f6c1b7e-9a41-4c2e-8f0d-1b2a3c4d5e6f
        '404':
          description: No stockback promo status row exists for this GCID.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataApiError'
              example:
                error:
                  code: stockback_promo_status_not_found
                  message: Stockback promo status was not found
                requestId: 3f6c1b7e-9a41-4c2e-8f0d-1b2a3c4d5e6f
        '429':
          description: >-
            Too Many Requests — the shared rate limit (60 requests / 60s) was
            exceeded.
          headers:
            RateLimit-Limit:
              description: >-
                Maximum number of requests allowed per window. This is the
                default shared pool used by every endpoint without a dedicated
                limit, so it is NOT per-endpoint — requests across those
                endpoints all draw from this one budget.
              schema:
                type: integer
              example: 60
            RateLimit-Remaining:
              description: Requests remaining in the current window for this quota.
              schema:
                type: integer
            RateLimit-Reset:
              description: Seconds until the current window resets.
              schema:
                type: integer
            RateLimit-Policy:
              description: Quota policy in the form `<limit>;w=<window-seconds>`.
              schema:
                type: string
              example: 60;w=60
            Retry-After:
              description: Seconds to wait before retrying.
              schema:
                type: integer
              example: 60
        '500':
          description: The query returned an inconsistent result for this GCID.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataApiError'
              example:
                error:
                  code: data_integrity_error
                  message: The requested resource could not be resolved
                requestId: 3f6c1b7e-9a41-4c2e-8f0d-1b2a3c4d5e6f
        '503':
          description: >-
            The serving dependency is temporarily unavailable; the upstream
            already retried with backoff before returning this. Safe to retry.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataApiError'
              example:
                error:
                  code: dependency_unavailable
                  message: The requested resource is temporarily unavailable
                requestId: 3f6c1b7e-9a41-4c2e-8f0d-1b2a3c4d5e6f
      security:
        - apiKeyAuth: []
          userKeyAuth: []
        - oauth2:
            - etoro-public:real:read
        - oauth2:
            - etoro-public:demo:read
        - oauth2:
            - etoro-public:real:write
        - oauth2:
            - etoro-public:demo:write
        - oauth2:
            - etoro-public:trade.real:read
        - oauth2:
            - etoro-public:trade.demo:read
components:
  schemas:
    StockbackPromoStatus:
      type: object
      description: >-
        The caller's current StockBack/Cashback promo enrollment and lifetime
        USD figures. Every field is nullable: a caller not (yet) enrolled in the
        promo still returns 200 with mostly-null values.
      properties:
        isOptedIn:
          type: boolean
          nullable: true
          description: Whether the caller is currently opted into the StockBack promo.
          example: true
        selectedStock:
          type: string
          nullable: true
          description: >-
            Ticker symbol of the stock the caller selected for StockBack, if
            opted in.
          example: AAPL
        currentIsPi:
          type: boolean
          nullable: true
          description: >-
            Whether the caller is currently classified as a Professional
            Investor.
          example: false
        rewardChannel:
          type: string
          nullable: true
          description: The channel this caller's reward is delivered through.
          example: stockback
        currentClub:
          type: string
          nullable: true
          description: The caller's current eToro Club tier.
          example: Silver
        currentCountry:
          type: string
          nullable: true
          description: The caller's current country.
          example: GB
        expectedCurrentMonthUsd:
          type: number
          format: double
          nullable: true
          description: Reward expected to accrue this calendar month, in USD.
          example: 12.34
        stockbackLifetimeUsd:
          type: number
          format: double
          nullable: true
          description: Lifetime StockBack reward earned, in USD.
          example: 100.5
        cashbackLifetimeUsd:
          type: number
          format: double
          nullable: true
          description: Lifetime Cashback reward earned, in USD.
          example: 50.25
        totalLifetimeUsd:
          type: number
          format: double
          nullable: true
          description: Lifetime total reward earned (StockBack + Cashback), in USD.
          example: 150.75
    DataApiError:
      type: object
      description: >-
        Error envelope returned by the data platform upstream. `requestId` is
        the correlation id for that call and is the fastest way for eToro
        support to find the request in logs.
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              description: Stable machine-readable error code.
            message:
              type: string
              description: >-
                Human-readable description. Not intended for display to end
                users.
          required:
            - code
            - message
        requestId:
          type: string
          nullable: true
          description: Correlation id for this request.
      required:
        - error
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        API key of the application. Only valid together with the x-user-key
        header — the pair is an alternative to OAuth bearer authentication,
        never sent alongside it. The pair is granted the same permissions the
        operation's OAuth scopes describe.


        Demo credential for trying the API from these docs:
        `lhgfaslk21490FAScVPkdsb53F9dNkfHG4faZSG5vfjndfcfgdssdgsdHF4663`
      x-default: lhgfaslk21490FAScVPkdsb53F9dNkfHG4faZSG5vfjndfcfgdssdgsdHF4663
    userKeyAuth:
      type: apiKey
      in: header
      name: x-user-key
      description: >-
        User-specific authentication key. Only valid together with the x-api-key
        header — the pair is an alternative to OAuth bearer authentication,
        never sent alongside it.


        Demo credential for trying the API from these docs:
        `eyJlYW4iOiJVbnJlZ2lzdGVyZWRBcHBsaWNhdGlvbiIsImVrIjoiOE5sZ2cwcW5EUVdROUFNWGpXT2lmOWktZnpidG5KcUlqWGJ3WHJZZkpZcldrbG90ZEhvLVBjSWhQaU8xU1ZtMW84aU1WZGZqN2xWNzFjLXFxLmcybXE1dnh4Q1hUT25xaWRUaTFlcEhmVk1fIn0_`
      x-default: >-
        eyJlYW4iOiJVbnJlZ2lzdGVyZWRBcHBsaWNhdGlvbiIsImVrIjoiOE5sZ2cwcW5EUVdROUFNWGpXT2lmOWktZnpidG5KcUlqWGJ3WHJZZkpZcldrbG90ZEhvLVBjSWhQaU8xU1ZtMW84aU1WZGZqN2xWNzFjLXFxLmcybXE1dnh4Q1hUT25xaWRUaTFlcEhmVk1fIn0_
    oauth2:
      type: oauth2
      description: >-
        eToro OAuth2 — send the access token as `Authorization: Bearer <token>`.
        Each operation lists the scopes that grant access as separate `security`
        requirements (OpenAPI OR semantics): the caller's token only needs ONE
        of them — you do NOT need all of them. Mutually exclusive with the
        x-api-key/x-user-key credential pair: never send both.
      flows:
        authorizationCode:
          authorizationUrl: https://www.etoro.com/sso
          tokenUrl: https://www.etoro.com/api/sso/v1/token
          scopes:
            etoro-public:agent-portfolio:read: Grants access to the 'etoro-public:agent-portfolio:read' scope.
            etoro-public:agent-portfolio:write: Grants access to the 'etoro-public:agent-portfolio:write' scope.
            etoro-public:club:read: Grants access to the 'etoro-public:club:read' scope.
            etoro-public:demo:read: Grants access to the 'etoro-public:demo:read' scope.
            etoro-public:demo:write: Grants access to the 'etoro-public:demo:write' scope.
            etoro-public:feed:read: Grants access to the 'etoro-public:feed:read' scope.
            etoro-public:feed:write: Grants access to the 'etoro-public:feed:write' scope.
            etoro-public:market-data:read: Grants access to the 'etoro-public:market-data:read' scope.
            etoro-public:money.balance:read: Grants access to the 'etoro-public:money.balance:read' scope.
            etoro-public:money.cash-transactions:read: >-
              Grants access to the 'etoro-public:money.cash-transactions:read'
              scope.
            etoro-public:money.transfer:read: Grants access to the 'etoro-public:money.transfer:read' scope.
            etoro-public:money.transfer:write: Grants access to the 'etoro-public:money.transfer:write' scope.
            etoro-public:money:transfer: Grants access to the 'etoro-public:money:transfer' scope.
            etoro-public:notifications:read: Grants access to the 'etoro-public:notifications:read' scope.
            etoro-public:notifications:write: Grants access to the 'etoro-public:notifications:write' scope.
            etoro-public:pi-data:read: Grants access to the 'etoro-public:pi-data:read' scope.
            etoro-public:price-alerts:read: Grants access to the 'etoro-public:price-alerts:read' scope.
            etoro-public:price-alerts:write: Grants access to the 'etoro-public:price-alerts:write' scope.
            etoro-public:real:read: Grants access to the 'etoro-public:real:read' scope.
            etoro-public:real:write: Grants access to the 'etoro-public:real:write' scope.
            etoro-public:sso-applications:read: Grants access to the 'etoro-public:sso-applications:read' scope.
            etoro-public:sso-applications:write: Grants access to the 'etoro-public:sso-applications:write' scope.
            etoro-public:sso-scopes:read: Grants access to the 'etoro-public:sso-scopes:read' scope.
            etoro-public:sso-scopes:write: Grants access to the 'etoro-public:sso-scopes:write' scope.
            etoro-public:sub-accounts:read: Grants access to the 'etoro-public:sub-accounts:read' scope.
            etoro-public:sub-accounts:write: Grants access to the 'etoro-public:sub-accounts:write' scope.
            etoro-public:trade.demo:read: Grants access to the 'etoro-public:trade.demo:read' scope.
            etoro-public:trade.demo:write: Grants access to the 'etoro-public:trade.demo:write' scope.
            etoro-public:trade.real:read: Grants access to the 'etoro-public:trade.real:read' scope.
            etoro-public:trade.real:write: Grants access to the 'etoro-public:trade.real:write' scope.
            etoro-public:user-info:read: Grants access to the 'etoro-public:user-info:read' scope.
            etoro-public:watchlist:read: Grants access to the 'etoro-public:watchlist:read' scope.
            etoro-public:watchlist:write: Grants access to the 'etoro-public:watchlist:write' scope.

````