openapi: 3.0.0
servers:
  - url: https://prod.api.market/api/v1/scout-llc/amazon-product-data
info:
  version: 1.0.0
  title: Amazon Product Data
  description: Affordable, Swift, and Reliable Amazon Data for Products, Price,
    Reviews and more in Real-Time
paths:
  /Amazon-Product-Data:
    get:
      tags:
        - Endpoints
      description: Returns Amazon product details
      parameters:
        - in: query
          name: asin
          description: Product ASIN (10-character alphanumeric code)
          required: true
          schema:
            type: string
        - in: query
          name: region
          description: The region of the Amazon store.
          required: false
          schema:
            type: string
            default: US
            enum:
              - US
              - AE
              - AU
              - BE
              - BR
              - CA
              - CN
              - DE
              - EG
              - ES
              - FR
              - IN
              - IT
              - JP
              - MX
              - NL
              - PL
              - SA
              - SE
              - SG
              - TR
              - UK
      responses:
        "200":
          description: A product object.
          content:
            application/json:
              schema:
                type: object
                properties:
                  product_name:
                    type: string
                    description: The name of the product.
                    example: VIVO Single Monitor Arm Desk Mount, Holds Screens up to 32 inch Regular
                      and 38 inch Ultrawide, Fully Adjustable Stand with C-Clamp
                      and Grommet Base, VESA 75x75mm or 100x100mm, Black,
                      STAND-V001
                  product_description:
                    type: string
                    description: A brief description of the product.
                    example: product description
                  product_image:
                    type: string
                    description: URL to the main product image.
                    example: https://m.media-amazon.com/images/I/61PB0ZYgUWL._AC_SY300_SX300_.jpg
                  thumbnail_images:
                    type: array
                    description: URLs to thumbnail images related to the product.
                    items:
                      type: string
                      example: https://m.media-amazon.com/images/I/31ti6UoyzOL._AC_US40_.jpg
                  star_rating:
                    type: string
                    description: The average star rating of the product.
                    example: "4.5"
                  num_ratings:
                    type: string
                    description: The number of ratings the product has received.
                    example: 17,496
                  price_info:
                    type: object
                    description: Detailed pricing information.
                    properties:
                      Price:
                        type: string
                        example: "29.99"
                  about_this_item:
                    type: array
                    description: Information about the product features.
                    items:
                      type: string
                      example: "Screen Compatibility - This single-arm mount fits screens that weigh
                        up to 22 lbs with backside mounting (VESA 75x75mm or
                        100x100mm). This covers most monitors on the market
                        between 13Ã¢â‚¬Â and 32Ã¢â‚¬Â, as well as ultrawide
                        monitors up to 38Ã¢â‚¬Â."
                  customer_summary:
                    type: string
                    description: Summary of customer reviews and feedback.
                    example: Customers like the ease of assembly of the flat screen display mount.
                      They mention that the instructions are clear and easy to
                      follow. They also appreciate the performance, saying that
                      it works well for their curved wide-screen monitor.
                      Customers are also satisfied with the quality, saying it
                      has good sturdy construction. They are also happy with
                      value, and appearance. However, some customers have mixed
                      opinions on stability, adjustability, and fit.
                  is_prime:
                    type: boolean
                    description: Wether it is a Amazon Prime product
                    example: true
                  reviews:
                    type: array
                    description: List of customer reviews for the product.
                    items:
                      type: object
                      properties:
                        review_id:
                          type: string
                          example: R7BU1S66OD3UJ
                        title:
                          type: string
                          example: Fantastic Arm, Easy Setup, will support 32" monitors easily
                        rating:
                          type: string
                          example: 5.0 out of 5 stars
                        timestamp:
                          type: string
                          example: Reviewed in the United States on February 8, 2019
                        verified_purchase:
                          type: boolean
                          example: true
                        text:
                          type: string
                          example: "Was looking to reduce clutter on my desk (Ikea Hilver desktop with
                            beveled edges, this VIVO easily clamped on) as i
                            began to rebuild a home music studio. This VIVO desk
                            stand is fantastic. It's very sturdy and well built
                            and easily supports my LG IPS 32\" monitor with ease
                            (Note: my monitor falls under the maximum weight for
                            this arm, which is why I was confident it would
                            work) Setup took a little longer than it needed to
                            but that's not necessarily VIVO's fault (more on
                            that below). As far as parts, everything is really
                            straight forward and does not require many steps to
                            have this up and running.A few things to consider -
                            I set this up on an Ikea Hilver desktop which has
                            beveled edges. Despite the Vivo sliding in deep
                            enough that I could clam it, I decided to buy a set
                            of nice solid wooden hexagonal coasters on amazon. I
                            used 2 coaster on the top and one under the desk to
                            clamp this on to. I did this because the Hilver is
                            not solid wood, rather, it is bamboo with honeycomb
                            filling and I was afraid that the weight of the
                            monitor could eventually cause the desk to break and
                            I didn't want this falling. So far, it is on there
                            really tight and sturdily and I do not see it having
                            any issues. The 4th coaster I use on the desk for
                            drinks. The hexagonal pattern under the clamp looks
                            nice and gives contrast to the bamboo color.My only
                            gripe with the VIVO is that the holes on the VESA
                            mount are a tad small. For whatever reason, LG
                            decided to use a 200x100 VESA pattern rather than
                            the more common 75x75 or 100x100 patterns. So, I
                            bought a vesa adapter plate as an intermediary
                            between the monitor and the VESA mount. The hardware
                            I needed to pass through the VIVO Vesa Mount was
                            slightly bigger than the hold on the mount - but i
                            solved that with my drill and drill bit and simply
                            made the holes bigger on the VIVO vesa plate. Took
                            all of 5 minutes. But had I not needed to used a
                            VESA adapter, the vivo mount would have mounted to
                            the LG perfectly with zero modifications needed so I
                            don't hold that against VIVO at all.all in all - i
                            love this thing and i don't know why I waited so
                            long to mount my monitor this way."
                        author:
                          type: string
                          example: Edwin R Rodriguez
                        helpful_votes:
                          type: string
                          example: One person found this helpful
        "204":
          description: No content, product not found
    parameters:
      - &a1
        description: API.market API Key
        in: header
        name: x-api-market-key
        value: Please Login/Signup to get an API Key
        required: true
        schema:
          type: string
  /Amazon-Search-Data:
    get:
      tags:
        - Endpoints
      description: Returns Amazon product details
      parameters:
        - in: query
          name: query
          description: Amazon search query (can have spaces).
          required: true
          schema:
            type: string
        - in: query
          name: region
          description: The region of the Amazon store.
          required: false
          schema:
            type: string
            default: US
            enum:
              - US
              - AE
              - AU
              - BE
              - BR
              - CA
              - CN
              - DE
              - EG
              - ES
              - FR
              - IN
              - IT
              - JP
              - MX
              - NL
              - PL
              - SA
              - SE
              - SG
              - TR
              - UK
        - in: query
          name: sort_by
          description: Sorting for the search results
          required: false
          schema:
            type: string
            default: RELEVANCE
            enum:
              - RELEVANCE
              - LOWEST_PRICE
              - HIGHEST_PRICE
              - REVIEWS
              - NEWEST
              - BEST_SELLERS
        - in: query
          name: min_price
          description: Filters products priced above the specified value.
          required: false
          schema:
            type: number
        - in: query
          name: max_price
          description: Filters products priced below the specified value.
          required: false
          schema:
            type: number
        - in: query
          name: page
          description: Specifies the page number for search results (default is 1).
          required: false
          schema:
            type: integer
            default: 1
      responses:
        "200":
          description: A list of products.
          content:
            application/json:
              schema:
                type: object
                properties:
                  products:
                    type: array
                    items:
                      type: object
                      properties:
                        asin:
                          type: string
                          example: B0BXNGJ2LD
                        product_title:
                          type: string
                          example: Rii RK907 Ultra-Slim Compact USB Wired Keyboard for Mac and PC, Windows
                            10/8 / 7 / Vista/XP (Black) (1PCS)
                        product_price:
                          type: string
                          example: $9.99
                        product_original_price:
                          type: string
                          example: $14.99
                        product_star_rating:
                          type: string
                          example: "4.5"
                        product_num_ratings:
                          type: string
                          example: "734"
                        product_image:
                          type: string
                          example: https://m.media-amazon.com/images/I/611G2Fw-4PL._AC_UY218_.jpg
                        is_prime:
                          type: boolean
                          example: true
                        amount_sold:
                          type: string
                          example: 3K+ bought in past month
                        delivery_info:
                          type: string
                          example: FREE delivery Fri, Sep 20 on $35 of items shipped by Amazon Or fastest
                            delivery Tue, Sep 17
                        productStatus:
                          type: string
                          example: Overall Pick
        "204":
          description: No content
    parameters:
      - *a1
  /Amazon-Bestsellers-Data:
    get:
      tags:
        - Endpoints
      description: Returns Amazon bestsellers by category
      parameters:
        - in: query
          name: category
          description: Amazon Bestseller category. Can also include subcategories.
          required: true
          schema:
            type: string
          examples:
            mobile-apps:
              value: mobile-apps
            mobile-apps-with-subcategory:
              value: mobile-apps/9209902011
        - in: query
          name: region
          description: The region of the Amazon store.
          required: false
          schema:
            type: string
            default: US
            enum:
              - US
              - AE
              - AU
              - BE
              - BR
              - CA
              - CN
              - DE
              - EG
              - ES
              - FR
              - IN
              - IT
              - JP
              - MX
              - NL
              - PL
              - SA
              - SE
              - SG
              - TR
              - UK
        - in: query
          name: page
          description: Return results for the specified page number (default is 1).
          required: false
          schema:
            type: integer
            default: 1
      responses:
        "200":
          description: A list of products.
          content:
            application/json:
              schema:
                type: object
                properties:
                  products:
                    type: array
                    items:
                      type: object
                      properties:
                        rank:
                          type: string
                          example: "#1"
                        asin:
                          type: string
                          example: B00992CF6W
                        product_title:
                          type: string
                          example: Minecraft
                        product_price:
                          type: array
                          items:
                            type: string
                          example:
                            - $6.99
                        product_star_rating:
                          type: string
                          example: "4.4"
                        product_num_ratings:
                          type: string
                          example: Mojang
                        product_image:
                          type: string
                          example: https://images-na.ssl-images-amazon.com/images/I/81gsSy5r13L._AC_UL300_SR300,200_.png
        "204":
          description: No content
    parameters:
      - *a1
security: {}
tags:
  - name: data
    description: Operations related to data
  - name: scraping
    description: Operations related to scraping
