soldgraph-com Account API

openapi: 3.2.0
info:
  title: Soldgraph Account API
  version: 1.0.0
  description: Resale listings from eight marketplaces (eBay in 8 countries; Vinted in the US, UK and 24 European countries; Poshmark and Whatnot in the US and Canada; Depop in the US, UK, Australia and Canada; the rest US), plus TCGplayer product search and recent card sales.
  contact:
    url: https://soldgraph.com/docs
servers:
- url: https://api.soldgraph.com/v1
security:
- bearer: []
tags:
- name: Account
paths:
  /usage:
    get:
      operationId: get_usage
      tags:
      - Account
      summary: Get your usage and allowance
      description: 'The same numbers the API uses to accept or refuse a search. Free: costs no request, but counts toward the per-minute rate limit.'
      responses:
        '200':
          description: Your usage.
          headers:
            X-Request-Id:
              description: Unique ID for this response. Include it when you contact support.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Usage'
        '401':
          description: 'invalid_api_key: The API key is missing, malformed or revoked.'
          headers:
            X-Request-Id:
              description: Unique ID for this response. Include it when you contact support.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: 'account_suspended: The account is suspended, so none of its keys work. Email support to restore it. origin_not_allowed: A browser sent the request from a site that isn''t allowed. Call the API from your server.'
          headers:
            X-Request-Id:
              description: Unique ID for this response. Include it when you contact support.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '405':
          description: 'method_not_allowed: Wrong method for this route. Searches, jobs and usage use GET. Only /v1/batches takes POST.'
          headers:
            X-Request-Id:
              description: Unique ID for this response. Include it when you contact support.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: 'rate_limited: More than 60 API calls this minute for your account.'
          headers:
            X-Request-Id:
              description: Unique ID for this response. Include it when you contact support.
              schema:
                type: string
            Retry-After:
              description: Seconds to wait before retrying.
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: 'storage_unavailable: Our database is briefly unavailable. origin_unavailable: The edge couldn''t reach our API server. service_unconfigured: The API is misconfigured on our side. Contact support.'
          headers:
            X-Request-Id:
              description: Unique ID for this response. Include it when you contact support.
              schema:
                type: string
            Retry-After:
              description: Seconds to wait before retrying.
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Usage:
      type: object
      required:
      - plan
      - used
      - limit
      - remaining
      - extra_requests
      - window
      - shared_allowance
      - rate_limit_per_minute
      properties:
        plan:
          type: string
          description: Your plan, like free or pro.
        used:
          type: integer
          description: 'Requests counted against the allowance: in the rolling 30 days, or of the one-time free credit when window is one_time. Free accounts include linked accounts.'
        limit:
          type:
          - integer
          - 'null'
          description: The plan's allowance per rolling 30 days, or the size of the one-time free credit when window is one_time. Null when unlimited.
        remaining:
          type:
          - integer
          - 'null'
          description: limit minus used, never below 0. Null when unlimited.
        extra_requests:
          type: integer
          description: Extra requests bought on top of the plan. Spent only after the allowance.
        window:
          type: string
          enum:
          - rolling_30_days
          - one_time
          description: 'rolling_30_days: usage frees up as it ages out. one_time: a free account''s one-time credit, which does not refill.'
        shared_allowance:
          type: boolean
          description: True when other linked free accounts draw on the same allowance.
        rate_limit_per_minute:
          type: integer
          description: API calls allowed per minute, job polls and this call included.
    Error:
      type: object
      required:
      - error
      properties:
        error:
          type: object
          required:
          - code
          properties:
            code:
              type: string
              enum:
              - invalid_api_key
              - account_suspended
              - origin_not_allowed
              - not_found
              - request_not_found
              - batch_not_found
              - method_not_allowed
              - idempotency_conflict
              - result_not_ready
              - payload_too_large
              - uri_too_long
              - unsupported_media_type
              - unsupported_or_invalid_query
              - duplicate_parameter
              - sort_not_implemented
              - invalid_idempotency_key
              - invalid_wait
              - invalid_body
              - batch_too_large
              - invalid_format
              - rate_limited
              - quota_exceeded
              - too_many_pending
              - upstream_daily_limit
              - queue_full
              - collection_unavailable
              - storage_unavailable
              - origin_unavailable
              - service_unconfigured
            message:
              type: string
              description: What the code means, in plain words. On every error; safe to show to a user.
            param:
              type: string
              description: 'On a 422: the input to fix, when it is one of the route''s inputs. Never a value.'
            index:
              type: integer
              description: 'On a refused batch: the position of the search to fix.'
            upgrade_url:
              type: string
              format: uri
              description: 'On quota_exceeded: the billing page, where you move to a larger plan or buy extra requests.'
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      description: An API key from the Soldgraph dashboard, starting with sg_.