MarketSDK Search API

openapi: 3.2.0
info:
  title: Marketsdk Search API
  version: 1.0.0
  contact: {}
  description: 'Operations tagged Search across 2 of this provider''s published API definitions: marketsdk-openapi.json, marketsdk-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.marketsdk.com
tags:
- name: Search
paths:
  /v1/search/listings:
    get:
      description: Full text over title and description, with filters and sorting. Only published listings with something available are returned. Callable with a publishable key.
      operationId: searchListings
      parameters:
      - name: q
        required: false
        in: query
        description: Full text over title and description.
        schema:
          maxLength: 200
          type: string
      - name: category
        required: false
        in: query
        schema:
          type: string
      - name: seller
        required: false
        in: query
        schema:
          type: string
      - name: min_price
        required: false
        in: query
        description: Minor units.
        schema:
          type: number
      - name: max_price
        required: false
        in: query
        description: Minor units.
        schema:
          type: number
      - name: attributes
        required: false
        in: query
        description: Attribute filters, as attributes[key]=value for equality, or attributes[key][gte]=n and attributes[key][lte]=n for numbers. Numeric filters need a category.
        schema:
          additionalProperties: true
          type: object
      - name: sort
        required: false
        in: query
        description: Relevance needs q. Default newest.
        schema:
          type: string
          enum:
          - relevance
          - newest
          - price_asc
          - price_desc
      - name: limit
        required: false
        in: query
        schema:
          minimum: 1
          maximum: 100
          default: 20
          type: number
      - name: cursor
        required: false
        in: query
        description: The next_cursor of the previous page.
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListingList'
        '400':
          description: The request is not valid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '401':
          description: No API key, or not a valid one.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '429':
          description: Rate limited. See `Retry-After`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
      security:
      - bearer: []
      summary: Search published listings
      tags:
      - Search
      x-publishable: true
    servers:
    - url: https://api.marketsdk.com
components:
  schemas:
    MoneyObject:
      type: object
      properties:
        amount:
          type: number
          description: Integer minor units.
          example: 4900
        currency:
          type: string
          example: USD
      required:
      - amount
      - currency
    ErrorEnvelope:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/ErrorBody'
      required:
      - error
    ListingObject:
      type: object
      properties:
        object:
          type: string
          enum:
          - listing
        id:
          type: string
          example: lst_034XtPDs7UJ0TXzTsdaHZa
        seller:
          type: string
        category:
          type:
          - string
          - 'null'
        title:
          type: string
        description:
          type:
          - string
          - 'null'
        price:
          $ref: '#/components/schemas/MoneyObject'
        quantity:
          type: number
        quantity_available:
          type: number
          description: Not reserved by an open order.
        status:
          type: string
          enum:
          - draft
          - published
          - sold
          - expired
          - removed
        attributes:
          type: object
          additionalProperties: true
        media:
          type: array
          items:
            $ref: '#/components/schemas/MediaObject'
        metadata:
          type: object
          additionalProperties:
            type: string
        published_at:
          type:
          - string
          - 'null'
          format: date-time
        expires_at:
          type:
          - string
          - 'null'
          format: date-time
        removed_reason:
          type:
          - string
          - 'null'
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
      required:
      - object
      - id
      - seller
      - category
      - title
      - description
      - price
      - quantity
      - quantity_available
      - status
      - attributes
      - media
      - metadata
      - published_at
      - expires_at
      - removed_reason
      - created_at
      - updated_at
    MediaObject:
      type: object
      properties:
        object:
          type: string
          enum:
          - media
        id:
          type: string
          example: med_034XtPDs7UJ0TXzTsdaHZa
        listing:
          type: string
        status:
          type: string
          enum:
          - pending
          - ready
        content_type:
          type: string
          example: image/jpeg
        size_bytes:
          type: number
        position:
          type: number
        url:
          type:
          - string
          - 'null'
          description: A signed link to the file, valid for an hour. Null until the upload completes.
        url_expires_at:
          type:
          - string
          - 'null'
          format: date-time
        created_at:
          type: string
          format: date-time
      required:
      - object
      - id
      - listing
      - status
      - content_type
      - size_bytes
      - position
      - url
      - url_expires_at
      - created_at
    ListingList:
      type: object
      properties:
        object:
          type: string
          enum:
          - list
        data:
          type: array
          items:
            $ref: '#/components/schemas/ListingObject'
        has_more:
          type: boolean
          description: Whether another page follows.
        next_cursor:
          type:
          - string
          - 'null'
          description: Pass as `starting_after` (or `cursor` for search) to get the next page.
      required:
      - object
      - data
      - has_more
      - next_cursor
    ErrorBody:
      type: object
      properties:
        code:
          type: string
          description: Machine-readable. Never changes once published.
          example: resource_missing
        message:
          type: string
          description: For people.
          example: No seller has that id.
        param:
          type: string
          description: The request field at fault.
          example: seller
        request_id:
          type: string
          example: req_7Gq0mR2s9xVbN4kT1pLc
      required:
      - code
      - message
      - request_id
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: API key
      type: http
      description: 'An API key: msk_test_sk_…, msk_live_sk_…, or a publishable msk_…_pk_… key where allowed.'
x-refined-from:
- marketsdk-openapi.json
- marketsdk-openapi.json
x-stripe-permissions:
- permission: accounts
  category: Core
  resource: Accounts
  level: Write
  used_for: Create sellers' connected accounts and read their status
- permission: account_links
  category: Connect
  resource: Account Links
  level: Write
  used_for: Onboarding links for sellers
- permission: transfers
  category: Connect
  resource: Transfers
  level: Write
  used_for: Release funds to a seller, and reverse them on a refund
- permission: payment_intents
  category: Core
  resource: Payment Intents
  level: Write
  used_for: Buyer payments, and cancelling unpaid ones
- permission: charges_and_refunds
  category: Core
  resource: Charges and Refunds
  level: Write
  used_for: Refunds, full and partial
- permission: checkout_sessions
  category: Checkout
  resource: Checkout Sessions
  level: Write
  used_for: Hosted checkout, and expiring unpaid sessions
- permission: identity_verification_sessions
  category: Identity
  resource: Verification Sessions and Reports
  level: Write
  used_for: Seller identity verification
- permission: disputes
  category: Core
  resource: Disputes
  level: Read
  used_for: Reading card disputes, to link them to orders
- permission: webhook_endpoints
  category: Webhook Endpoints
  resource: Webhook Endpoints
  level: Write
  used_for: Registering our endpoint on your account