{
  "openapi": "3.0.1",
  "info": {
    "title": "ShopGoodwill Scraper: Sold Comps & Auction Monitor",
    "description": "Search active ShopGoodwill auctions and source-published sold comps. Export prices, bids, shipping, end times, seller data, and meaningful auction changes for resale sourcing. Built for n8n, Make, Zapier, and API workflows. $0.00199 per lot.",
    "version": "0.2",
    "x-build-id": "d9fbMQzB8Zmnsgacx"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/getascraper~shopgoodwill-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-getascraper-shopgoodwill-scraper",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/acts/getascraper~shopgoodwill-scraper/runs": {
      "post": {
        "operationId": "runs-sync-getascraper-shopgoodwill-scraper",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor and returns information about the initiated run in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/runsResponseSchema"
                }
              }
            }
          }
        }
      }
    },
    "/acts/getascraper~shopgoodwill-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-getascraper-shopgoodwill-scraper",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "inputSchema": {
        "type": "object",
        "properties": {
          "searchQueries": {
            "title": "Search keywords",
            "type": "array",
            "description": "Search terms such as vintage camera, sterling silver, or Nintendo. All supplied sources are combined and deduplicated.",
            "items": {
              "type": "string"
            },
            "default": []
          },
          "startUrls": {
            "title": "ShopGoodwill URLs",
            "type": "array",
            "description": "Supported search, category, seller, or item URLs. URLs are added to the other sources rather than replacing them.",
            "default": [],
            "items": {
              "type": "object",
              "required": [
                "url"
              ],
              "properties": {
                "url": {
                  "type": "string",
                  "title": "URL of a web page",
                  "format": "uri"
                }
              }
            }
          },
          "categoryIds": {
            "title": "Category IDs",
            "type": "array",
            "description": "Optional numeric ShopGoodwill category IDs. Combine several categories in one run.",
            "items": {
              "type": "integer",
              "minimum": 1
            },
            "default": []
          },
          "sellerIds": {
            "title": "Seller IDs",
            "type": "array",
            "description": "Optional numeric IDs for regional Goodwill sellers or stores.",
            "items": {
              "type": "integer",
              "minimum": 1
            },
            "default": []
          },
          "itemIds": {
            "title": "Item IDs",
            "type": "array",
            "description": "Optional ShopGoodwill item IDs for direct item collection.",
            "items": {
              "type": "integer",
              "minimum": 1
            },
            "default": []
          },
          "auctionState": {
            "title": "Auction data to collect",
            "enum": [
              "active",
              "sold",
              "both"
            ],
            "type": "string",
            "description": "Choose active listings, recent sold comps, or both when the source supports them.",
            "default": "active"
          },
          "closedAuctionDaysBack": {
            "title": "Sold-comp lookback days",
            "minimum": 1,
            "maximum": 90,
            "type": "integer",
            "description": "How far back to search when sold comps are selected.",
            "default": 30
          },
          "minPrice": {
            "title": "Minimum price",
            "minimum": 0,
            "type": "number",
            "description": "Keep lots at or above this source price."
          },
          "maxPrice": {
            "title": "Maximum price",
            "minimum": 0,
            "type": "number",
            "description": "Keep lots at or below this source price."
          },
          "sortBy": {
            "title": "Sort order",
            "enum": [
              "endingSoonest",
              "endingLatest",
              "newest",
              "oldest",
              "priceLow",
              "priceHigh",
              "mostBids",
              "fewestBids",
              "titleAZ",
              "titleZA"
            ],
            "type": "string",
            "description": "Order source results before the global result cap is applied.",
            "default": "endingSoonest"
          },
          "buyNowOnly": {
            "title": "Buy It Now only",
            "type": "boolean",
            "description": "Keep lots with a source-published Buy It Now option.",
            "default": false
          },
          "pickupOnly": {
            "title": "Local pickup only",
            "type": "boolean",
            "description": "Keep lots marked for local pickup.",
            "default": false
          },
          "oneCentShippingOnly": {
            "title": "One-cent shipping only",
            "type": "boolean",
            "description": "Keep lots with a source-published shipping price of $0.01.",
            "default": false
          },
          "searchDescriptions": {
            "title": "Search listing descriptions",
            "type": "boolean",
            "description": "Ask the source to include listing-description text in keyword matching when available.",
            "default": false
          },
          "maxItems": {
            "title": "Maximum results",
            "minimum": 1,
            "maximum": 50000,
            "type": "integer",
            "description": "One hard global cap across every search, URL, category, seller, and item source in this run.",
            "default": 100
          },
          "fetchDetails": {
            "title": "Fetch lot details",
            "type": "boolean",
            "description": "Request available description, image gallery, seller, pickup, shipping, and bid-detail fields for each collected lot.",
            "default": false
          },
          "runMode": {
            "title": "Run mode",
            "enum": [
              "snapshot",
              "monitor"
            ],
            "type": "string",
            "description": "Use monitoring to save and charge only new or meaningful auction changes for the same state key.",
            "default": "snapshot"
          },
          "stateKey": {
            "title": "Monitoring state key",
            "type": "string",
            "description": "Optional name for this saved monitoring scope. Reuse it for every scheduled run of the same scope.",
            "default": "default"
          },
          "resetState": {
            "title": "Reset monitoring state",
            "type": "boolean",
            "description": "Forget previously seen lots for this monitoring scope before the run.",
            "default": false
          },
          "closingSoonMinutes": {
            "title": "Closing-soon window in minutes",
            "minimum": 1,
            "maximum": 10080,
            "type": "integer",
            "description": "Emit one closing-soon event when an active auction enters this time window.",
            "default": 60
          },
          "proxyConfiguration": {
            "title": "Proxy configuration",
            "type": "object",
            "description": "ShopGoodwill requires a working proxy connection for cloud collection.",
            "default": {
              "useApifyProxy": true,
              "apifyProxyGroups": [
                "BUYPROXIES94952"
              ]
            }
          }
        }
      },
      "runsResponseSchema": {
        "type": "object",
        "properties": {
          "data": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "actId": {
                "type": "string"
              },
              "userId": {
                "type": "string"
              },
              "startedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "finishedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "status": {
                "type": "string",
                "example": "READY"
              },
              "meta": {
                "type": "object",
                "properties": {
                  "origin": {
                    "type": "string",
                    "example": "API"
                  },
                  "userAgent": {
                    "type": "string"
                  }
                }
              },
              "stats": {
                "type": "object",
                "properties": {
                  "inputBodyLen": {
                    "type": "integer",
                    "example": 2000
                  },
                  "rebootCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "restartCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "resurrectCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "computeUnits": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "options": {
                "type": "object",
                "properties": {
                  "build": {
                    "type": "string",
                    "example": "latest"
                  },
                  "timeoutSecs": {
                    "type": "integer",
                    "example": 300
                  },
                  "memoryMbytes": {
                    "type": "integer",
                    "example": 1024
                  },
                  "diskMbytes": {
                    "type": "integer",
                    "example": 2048
                  }
                }
              },
              "buildId": {
                "type": "string"
              },
              "defaultKeyValueStoreId": {
                "type": "string"
              },
              "defaultDatasetId": {
                "type": "string"
              },
              "defaultRequestQueueId": {
                "type": "string"
              },
              "buildNumber": {
                "type": "string",
                "example": "1.0.0"
              },
              "containerUrl": {
                "type": "string"
              },
              "usage": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "integer",
                    "example": 1
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "usageTotalUsd": {
                "type": "number",
                "example": 0.00005
              },
              "usageUsd": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "number",
                    "example": 0.00005
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}