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

# Get a product's sales history

> An Etsy product's (another seller's listing) monthly sales history. Every completed UTC calendar month of estimated sales, estimated revenue (whole USD, valued at the current price, not the price at the time) and reviews written, oldest first, in one response. The month still running is never included; a month Alura has no values for is listed with nulls. Carries `methodology_version` and `methodology_url`: estimates can change as late reviews arrive. Needs a plan with full historic data (Growth and above; otherwise 403 `plan_required`). History never fetches anything: a resource Alura has not seen is 404 `not_found`.

Cost: 1 API credit per call.



## OpenAPI

````yaml /openapi.json get /v1/research/products/{id}/history
openapi: 3.1.0
info:
  title: Alura API
  version: 1.0.0
  description: Etsy market research for scripts and AI assistants.
servers:
  - url: https://api.alura.io
security:
  - apiKey: []
paths:
  /v1/research/products/{id}/history:
    get:
      summary: Get a product's sales history
      description: >-
        An Etsy product's (another seller's listing) monthly sales history.
        Every completed UTC calendar month of estimated sales, estimated revenue
        (whole USD, valued at the current price, not the price at the time) and
        reviews written, oldest first, in one response. The month still running
        is never included; a month Alura has no values for is listed with nulls.
        Carries `methodology_version` and `methodology_url`: estimates can
        change as late reviews arrive. Needs a plan with full historic data
        (Growth and above; otherwise 403 `plan_required`). History never fetches
        anything: a resource Alura has not seen is 404 `not_found`.


        Cost: 1 API credit per call.
      operationId: research.products.history
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            pattern: ^[1-9][0-9]{0,19}$
            description: Etsy listing ID.
            example: '4524717183'
        - name: fields
          in: query
          required: false
          description: >-
            Comma-separated dotted paths to return; `id`, `object` and `as_of`
            always come back.
          schema:
            type: string
      responses:
        '200':
          description: OK
          headers:
            Request-Id:
              $ref: '#/components/headers/Request-Id'
            Alura-Credits-Cost:
              $ref: '#/components/headers/Alura-Credits-Cost'
            Alura-Credits-Remaining:
              $ref: '#/components/headers/Alura-Credits-Remaining'
          content:
            application/json:
              schema:
                type: object
                properties:
                  object:
                    type: string
                    const: research.history
                  resource:
                    type: object
                    properties:
                      object:
                        type: string
                        enum:
                          - research.product
                          - research.shop
                      id:
                        type: string
                        description: Etsy ID, as a string.
                    required:
                      - object
                      - id
                    additionalProperties: false
                    description: Whose history this is.
                  granularity:
                    type: string
                    const: month
                  history_through:
                    type: string
                    pattern: ^\d{4}-(0[1-9]|1[0-2])$
                    description: >-
                      The last completed UTC month. The month still running is
                      never included.
                  methodology_version:
                    type: string
                    description: The version of the estimate methodology the values follow.
                  methodology_url:
                    type: string
                    description: How the estimates are made, and how accurate they are.
                  data:
                    anyOf:
                      - type: array
                        items:
                          type: object
                          properties:
                            month:
                              type: string
                              pattern: ^\d{4}-(0[1-9]|1[0-2])$
                              description: A UTC calendar month, `YYYY-MM`.
                            est_sales:
                              description: >-
                                Estimated sales in the month; null when Alura
                                has no value for it.


                                Estimate: see the methodology (version 2026-10)
                                at
                                https://docs.alura.io/methodology/sales-estimates.
                              type:
                                - number
                                - 'null'
                            est_revenue_usd:
                              description: >-
                                Estimated revenue in the month, whole USD,
                                valued at the current price (not the price at
                                the time); null when the sales or the price are
                                unknown.


                                Estimate: see the methodology (version 2026-10)
                                at
                                https://docs.alura.io/methodology/sales-estimates.
                              type:
                                - number
                                - 'null'
                            reviews:
                              anyOf:
                                - type: integer
                                - type: 'null'
                              description: Reviews written in the month; null when unknown.
                          required:
                            - month
                            - est_sales
                            - est_revenue_usd
                            - reviews
                          additionalProperties: false
                      - type: 'null'
                    description: >-
                      Every completed month from the first Alura has through
                      `history_through`, oldest first. A month Alura has no
                      values for is in the list with nulls, never 0. null when
                      Alura has no usable history for this resource.
                  as_of:
                    type: string
                    description: ISO 8601, UTC. When this data was last updated from Etsy.
                required:
                  - object
                  - resource
                  - granularity
                  - history_through
                  - methodology_version
                  - methodology_url
                  - data
                  - as_of
                additionalProperties: false
              example:
                object: research.history
                resource:
                  object: research.product
                  id: '4524717183'
                granularity: month
                history_through: 2026-09
                methodology_version: 2026-10
                methodology_url: https://docs.alura.io/methodology/sales-estimates
                data:
                  - month: 2026-06
                    est_sales: 198
                    est_revenue_usd: 5366
                    reviews: 17
                  - month: 2026-07
                    est_sales: 214
                    est_revenue_usd: 5799
                    reviews: 19
                  - month: 2026-08
                    est_sales: null
                    est_revenue_usd: null
                    reviews: null
                  - month: 2026-09
                    est_sales: 236
                    est_revenue_usd: 6396
                    reviews: 21
                as_of: '2026-10-13T09:30:00Z'
        '400':
          $ref: '#/components/responses/Problem400'
        '401':
          $ref: '#/components/responses/Problem401'
        '402':
          $ref: '#/components/responses/Problem402'
        '403':
          $ref: '#/components/responses/Problem403'
        '404':
          $ref: '#/components/responses/Problem404'
        '405':
          $ref: '#/components/responses/Problem405'
        '429':
          $ref: '#/components/responses/Problem429'
        '500':
          $ref: '#/components/responses/Problem500'
        '503':
          $ref: '#/components/responses/Problem503'
      x-codeSamples:
        - lang: bash
          label: cURL
          source: >-
            curl "https://api.alura.io/v1/research/products/4524717183/history"
            \
              -H "Authorization: Bearer $ALURA_API_KEY"
        - lang: typescript
          label: TypeScript
          source: >-
            const res = await
            fetch('https://api.alura.io/v1/research/products/4524717183/history',
            {
              headers: {
                Authorization: `Bearer ${process.env.ALURA_API_KEY}`,
              },
            });

            console.log(await res.json());
        - lang: python
          label: Python
          source: |-
            import json
            import os
            import urllib.request

            request = urllib.request.Request(
                "https://api.alura.io/v1/research/products/4524717183/history",
                headers={
                    "Authorization": f"Bearer {os.environ['ALURA_API_KEY']}",
                },
            )
            with urllib.request.urlopen(request) as response:
                print(json.load(response))
components:
  headers:
    Request-Id:
      description: '`req_` + ULID; quote it when reporting a problem.'
      schema:
        type: string
    Alura-Credits-Cost:
      description: API credits this call cost.
      schema:
        type: integer
    Alura-Credits-Remaining:
      description: >-
        API credits left in the workspace's monthly allowance, counting calls
        still in flight. Absent when it cannot be read right now.
      schema:
        type: integer
  responses:
    Problem400:
      description: Error
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          example:
            type: https://docs.alura.io/errors/invalid_request
            title: Invalid request
            status: 400
            code: invalid_request
            detail: Invalid request
            suggestion: Fix the request as the detail says, then send it again.
            retryable: false
            request_id: req_01JQ5W3H8M2N4P6R8T0V2X4Z6B
    Problem401:
      description: Error
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          example:
            type: https://docs.alura.io/errors/unauthorized
            title: Unauthorized
            status: 401
            code: unauthorized
            detail: Unauthorized
            suggestion: 'Send a valid API key as `Authorization: Bearer alura_sk_...`.'
            retryable: false
            request_id: req_01JQ5W3H8M2N4P6R8T0V2X4Z6B
    Problem402:
      description: Error
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          example:
            type: https://docs.alura.io/errors/credits_exhausted
            title: API credits exhausted
            status: 402
            code: credits_exhausted
            detail: API credits exhausted
            suggestion: Upgrade the plan or wait for the monthly reset.
            retryable: false
            request_id: req_01JQ5W3H8M2N4P6R8T0V2X4Z6B
    Problem403:
      description: Error
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          example:
            type: https://docs.alura.io/errors/plan_required
            title: Plan required
            status: 403
            code: plan_required
            detail: Plan required
            suggestion: Upgrade the workspace plan to use this operation.
            retryable: false
            request_id: req_01JQ5W3H8M2N4P6R8T0V2X4Z6B
    Problem404:
      description: Error
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          example:
            type: https://docs.alura.io/errors/not_found
            title: Not found
            status: 404
            code: not_found
            detail: Not found
            suggestion: Check the ID, or search for it first.
            retryable: false
            request_id: req_01JQ5W3H8M2N4P6R8T0V2X4Z6B
    Problem405:
      description: Error
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          example:
            type: https://docs.alura.io/errors/method_not_allowed
            title: Method not allowed
            status: 405
            code: method_not_allowed
            detail: Method not allowed
            suggestion: Use one of the methods in the Allow header.
            retryable: false
            request_id: req_01JQ5W3H8M2N4P6R8T0V2X4Z6B
    Problem429:
      description: Error
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          example:
            type: https://docs.alura.io/errors/rate_limited
            title: Rate limited
            status: 429
            code: rate_limited
            detail: Rate limited
            suggestion: Wait for Retry-After, then retry.
            retryable: true
            request_id: req_01JQ5W3H8M2N4P6R8T0V2X4Z6B
    Problem500:
      description: Error
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          example:
            type: https://docs.alura.io/errors/internal_error
            title: Internal error
            status: 500
            code: internal_error
            detail: Internal error
            suggestion: Retry; if it keeps failing, report the request_id.
            retryable: true
            request_id: req_01JQ5W3H8M2N4P6R8T0V2X4Z6B
    Problem503:
      description: Error
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          example:
            type: https://docs.alura.io/errors/credits_unavailable
            title: API credits unavailable
            status: 503
            code: credits_unavailable
            detail: API credits unavailable
            suggestion: Retry shortly.
            retryable: true
            request_id: req_01JQ5W3H8M2N4P6R8T0V2X4Z6B
  schemas:
    Problem:
      type: object
      description: RFC 9457 problem details.
      properties:
        type:
          type: string
          format: uri
        title:
          type: string
        status:
          type: integer
        code:
          type: string
          description: A code from the error catalog; new codes may be added.
          x-extensible-enum:
            - invalid_request
            - unknown_parameter
            - invalid_cursor
            - cursor_window_exceeded
            - id_type_mismatch
            - invalid_keyword
            - unauthorized
            - credits_exhausted
            - plan_required
            - insufficient_scope
            - workspace_required
            - workspace_locked
            - browser_refused
            - role_required
            - impersonation_refused
            - recent_sign_in_required
            - not_found
            - not_found_on_etsy
            - shop_opted_out
            - method_not_allowed
            - conflict
            - key_limit_reached
            - idempotency_processing
            - unprocessable
            - rate_limited
            - throttled
            - daily_credit_cap_exceeded
            - credits_reserved
            - fetch_limit_reached
            - internal_error
            - upstream_unavailable
            - credits_unavailable
            - service_unavailable
            - fetch_unavailable
            - upstream_timeout
        detail:
          type: string
        suggestion:
          type: string
        retryable:
          type: boolean
        request_id:
          type: string
        upgrade_url:
          type: string
          format: uri
          description: 'credits_exhausted and plan_required: where to upgrade the plan.'
        credits_needed:
          type: integer
          description: 'API credit refusals: what the call needed.'
        credits_remaining:
          type: integer
          description: >-
            API credit refusals: what is left (of the month, or of the day for
            daily_credit_cap_exceeded).
        resets_at:
          type: string
          format: date-time
          description: >-
            credits_exhausted and daily_credit_cap_exceeded: when the limit
            resets.
      required:
        - type
        - title
        - status
        - code
        - detail
        - suggestion
        - retryable
        - request_id
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: 'An API key: `Authorization: Bearer alura_sk_...`.'

````

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