> ## 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.

# Find similar products

> Finds Etsy products (other sellers' listings) like the given one: products whose titles and tags share its words rank first, and products in the same category rank higher. Returns product summaries with Alura's sales estimates, best match first; the product itself is never among them. Only active listings are returned; shops that opted out of Alura never appear. The totals stop counting at 10,000 and paging stops after 10,000 results. A product Alura has not seen is 404 `not_found` (nothing is fetched). Costs 10 API credits per page with results; an empty page is free.

Cost: 10 API credits per page.



## OpenAPI

````yaml /openapi.json get /v1/research/products/{id}/similar
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}/similar:
    get:
      summary: Find similar products
      description: >-
        Finds Etsy products (other sellers' listings) like the given one:
        products whose titles and tags share its words rank first, and products
        in the same category rank higher. Returns product summaries with Alura's
        sales estimates, best match first; the product itself is never among
        them. Only active listings are returned; shops that opted out of Alura
        never appear. The totals stop counting at 10,000 and paging stops after
        10,000 results. A product Alura has not seen is 404 `not_found` (nothing
        is fetched). Costs 10 API credits per page with results; an empty page
        is free.


        Cost: 10 API credits per page.
      operationId: research.products.similar
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            pattern: ^[1-9][0-9]{0,19}$
            description: Etsy listing ID.
            example: '4524717183'
        - name: limit
          in: query
          required: false
          description: 'Page size: default 25, at most 100.'
          schema:
            type: integer
            minimum: 1
            maximum: 100
        - name: cursor
          in: query
          required: false
          description: >-
            The `next_cursor` of the previous page. Bound to the query, the
            workspace and the key.
          schema:
            type: string
        - 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: list
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        object:
                          type: string
                          const: research.product
                        id:
                          type: string
                          description: Etsy ID, as a string.
                        title:
                          type:
                            - string
                            - 'null'
                        url:
                          type: string
                          description: The listing on Etsy.
                        shop:
                          type: object
                          properties:
                            id:
                              type: string
                              description: Etsy ID, as a string.
                            name:
                              type:
                                - string
                                - 'null'
                          required:
                            - id
                            - name
                          additionalProperties: false
                        price:
                          anyOf:
                            - type: object
                              properties:
                                amount:
                                  type: string
                                  description: >-
                                    Decimal string in the listing's own
                                    currency.
                                currency:
                                  type: string
                                  description: ISO 4217 code.
                                usd:
                                  description: >-
                                    The same price in USD, as a decimal string;
                                    null when no exchange rate is known.
                                  type:
                                    - string
                                    - 'null'
                              required:
                                - amount
                                - currency
                                - usd
                              additionalProperties: false
                              description: The listing's current price.
                            - type: 'null'
                        image_url:
                          description: The primary image (570px wide).
                          type:
                            - string
                            - 'null'
                        category:
                          anyOf:
                            - type: object
                              properties:
                                id:
                                  anyOf:
                                    - type: string
                                      description: Etsy ID, as a string.
                                    - type: 'null'
                                path:
                                  type: array
                                  items:
                                    type: string
                              required:
                                - id
                                - path
                              additionalProperties: false
                            - type: 'null'
                        sales:
                          type: object
                          properties:
                            est_lifetime:
                              type:
                                - number
                                - 'null'
                              description: >-
                                Estimate: see the methodology (version 2026-10)
                                at
                                https://docs.alura.io/methodology/sales-estimates.
                            est_monthly_avg:
                              type:
                                - number
                                - 'null'
                              description: >-
                                Estimate: see the methodology (version 2026-10)
                                at
                                https://docs.alura.io/methodology/sales-estimates.
                            est_lifetime_revenue_usd:
                              type:
                                - number
                                - 'null'
                              description: >-
                                Estimate: see the methodology (version 2026-10)
                                at
                                https://docs.alura.io/methodology/sales-estimates.
                          required:
                            - est_lifetime
                            - est_monthly_avg
                            - est_lifetime_revenue_usd
                          additionalProperties: false
                          description: >-
                            Estimates (methodology:
                            https://docs.alura.io/methodology/sales-estimates).
                            Revenue is valued at the current price.
                        reviews:
                          type: object
                          properties:
                            count:
                              anyOf:
                                - type: integer
                                - type: 'null'
                            average:
                              description: null when there are no reviews.
                              type:
                                - number
                                - 'null'
                          required:
                            - count
                            - average
                          additionalProperties: false
                        favorites:
                          anyOf:
                            - type: integer
                            - type: 'null'
                        listing_score:
                          anyOf:
                            - type: integer
                            - type: 'null'
                          description: Alura's 0-100 listing score.
                        listed_at:
                          anyOf:
                            - type: string
                              description: ISO 8601, UTC.
                            - type: 'null'
                        as_of:
                          anyOf:
                            - type: string
                              description: ISO 8601, UTC.
                            - type: 'null'
                          description: >-
                            When this data was last updated. In search results:
                            when Alura's search copy of the product was last
                            synced (an approximation for older copies; null when
                            unknown), which can differ from the product detail's
                            `as_of`. In a bulk get by `ids`: the product
                            detail's `as_of`.
                      required:
                        - object
                        - id
                        - title
                        - url
                        - shop
                        - price
                        - image_url
                        - category
                        - sales
                        - reviews
                        - favorites
                        - listing_score
                        - listed_at
                        - as_of
                      additionalProperties: false
                  has_more:
                    type: boolean
                  next_cursor:
                    type:
                      - string
                      - 'null'
                  total:
                    type: object
                    properties:
                      value:
                        type: integer
                      relation:
                        type: string
                        enum:
                          - eq
                          - gte
                    required:
                      - value
                      - relation
                    additionalProperties: false
                required:
                  - object
                  - data
                  - has_more
                  - next_cursor
                  - total
                additionalProperties: false
              example:
                object: list
                data:
                  - object: research.product
                    id: '1587263044'
                    title: Custom Name Coffee Mug, Personalized Gift Mug
                    url: https://www.etsy.com/listing/1587263044
                    shop:
                      id: '30577120'
                      name: ClayAndName
                    price:
                      amount: '19.50'
                      currency: USD
                      usd: '19.50'
                    image_url: >-
                      https://i.etsystatic.com/30577120/r/il/7c8d9e/1587263044/il_570xN.1587263044_mug2.jpg
                    category:
                      id: '1062'
                      path:
                        - Home & Living
                        - Kitchen & Dining
                        - Drink & Barware
                        - Drinkware
                        - Mugs
                    sales:
                      est_lifetime: 2900
                      est_monthly_avg: 95
                      est_lifetime_revenue_usd: 56550
                    reviews:
                      count: 410
                      average: 4.8
                    favorites: 1280
                    listing_score: 79
                    listed_at: '2024-01-18T15:42:00.000Z'
                    as_of: '2026-10-12T21:14:00.000Z'
                  - object: research.product
                    id: '1349902215'
                    title: Personalized Mug with Name, Birthday Gift
                    url: https://www.etsy.com/listing/1349902215
                    shop:
                      id: '22841907'
                      name: GiftMugStudio
                    price:
                      amount: '22.00'
                      currency: GBP
                      usd: '28.60'
                    image_url: >-
                      https://i.etsystatic.com/22841907/r/il/3f4a5b/1349902215/il_570xN.1349902215_mug3.jpg
                    category:
                      id: '1062'
                      path:
                        - Home & Living
                        - Kitchen & Dining
                        - Drink & Barware
                        - Drinkware
                        - Mugs
                    sales:
                      est_lifetime: 1750
                      est_monthly_avg: 60
                      est_lifetime_revenue_usd: 50050
                    reviews:
                      count: 233
                      average: 4.9
                    favorites: 905
                    listing_score: 74
                    listed_at: '2022-11-03T08:20:00.000Z'
                    as_of: '2026-10-13T06:51:00.000Z'
                has_more: false
                next_cursor: null
                total:
                  value: 2
                  relation: eq
        '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/similar"
            \
              -H "Authorization: Bearer $ALURA_API_KEY"
        - lang: typescript
          label: TypeScript
          source: >-
            const res = await
            fetch('https://api.alura.io/v1/research/products/4524717183/similar',
            {
              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/similar",
                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.