From 9ffc4fcb256602506305ccad5c01d46274a4866b Mon Sep 17 00:00:00 2001 From: Aaron <7063649+ahcode0919@users.noreply.github.com> Date: Sun, 1 Nov 2026 20:45:09 -0800 Subject: [PATCH 1/3] Add Bruno spec and OpenAPI spec --- bruno/PricechartingAPI/.env.example | 2 + bruno/PricechartingAPI/.gitignore | 10 + .../Marketplace API/folder.yml | 38 + .../Marketplace API/offer-details.yml | 79 ++ .../Marketplace API/offer-end.yml | 40 + .../Marketplace API/offer-feedback.yml | 46 + .../Marketplace API/offer-publish.yml | 139 +++ .../Marketplace API/offer-refund.yml | 40 + .../Marketplace API/offer-ship.yml | 45 + .../Marketplace API/offers.yml | 111 ++ bruno/PricechartingAPI/Prices API/folder.yml | 14 + bruno/PricechartingAPI/Prices API/product.yml | 113 ++ .../PricechartingAPI/Prices API/products.yml | 65 ++ .../environments/Production.yml | 5 + bruno/PricechartingAPI/environments/Test.yml | 5 + bruno/PricechartingAPI/opencollection.yml | 105 ++ open_api/pricecharting.yaml | 1020 +++++++++++++++++ 17 files changed, 1877 insertions(+) create mode 100644 bruno/PricechartingAPI/.env.example create mode 100644 bruno/PricechartingAPI/.gitignore create mode 100644 bruno/PricechartingAPI/Marketplace API/folder.yml create mode 100644 bruno/PricechartingAPI/Marketplace API/offer-details.yml create mode 100644 bruno/PricechartingAPI/Marketplace API/offer-end.yml create mode 100644 bruno/PricechartingAPI/Marketplace API/offer-feedback.yml create mode 100644 bruno/PricechartingAPI/Marketplace API/offer-publish.yml create mode 100644 bruno/PricechartingAPI/Marketplace API/offer-refund.yml create mode 100644 bruno/PricechartingAPI/Marketplace API/offer-ship.yml create mode 100644 bruno/PricechartingAPI/Marketplace API/offers.yml create mode 100644 bruno/PricechartingAPI/Prices API/folder.yml create mode 100644 bruno/PricechartingAPI/Prices API/product.yml create mode 100644 bruno/PricechartingAPI/Prices API/products.yml create mode 100644 bruno/PricechartingAPI/environments/Production.yml create mode 100644 bruno/PricechartingAPI/environments/Test.yml create mode 100644 bruno/PricechartingAPI/opencollection.yml create mode 100644 open_api/pricecharting.yaml diff --git a/bruno/PricechartingAPI/.env.example b/bruno/PricechartingAPI/.env.example new file mode 100644 index 0000000..5e3e590 --- /dev/null +++ b/bruno/PricechartingAPI/.env.example @@ -0,0 +1,2 @@ +PRICECHARTING_TOKEN=your_40_character_api_token +PRICECHARTING_TEST_TOKEN=your_40_character_api_token \ No newline at end of file diff --git a/bruno/PricechartingAPI/.gitignore b/bruno/PricechartingAPI/.gitignore new file mode 100644 index 0000000..0f6053a --- /dev/null +++ b/bruno/PricechartingAPI/.gitignore @@ -0,0 +1,10 @@ +# Secrets +.env* +!.env.example + +# Dependencies +node_modules + +# OS files +.DS_Store +Thumbs.db \ No newline at end of file diff --git a/bruno/PricechartingAPI/Marketplace API/folder.yml b/bruno/PricechartingAPI/Marketplace API/folder.yml new file mode 100644 index 0000000..8c03356 --- /dev/null +++ b/bruno/PricechartingAPI/Marketplace API/folder.yml @@ -0,0 +1,38 @@ +info: + name: Marketplace API + type: folder + seq: 2 + +request: + auth: inherit + +docs: + content: |- + Automate selling on the PriceCharting Marketplace. + + Prices are integer pennies. Throttle `/api/offers` requests to the same URL to once per 5 minutes. + + #### `offer-status` values + `available`, `sold`, `ended`, `pending` (vacation hold or payment issue, see `pending-reason`), `collection` + + #### Condition IDs (`condition-id`) + + | ID | Video Games | Cards | Comics | Coins | + |---|---|---|---|---| + | 1 | Loose | Ungraded | Ungraded | Ungraded | + | 2 | New & Sealed | Grade 8 | 6.0 | AU (50-58) | + | 3 | CIB | Grade 7 | 4.0 | VF (20-35) | + | 5 | Graded | Grade 9 | 8.0 | MS62 | + | 6 | Box only | Grade 9.5 | 9.2 | MS64 | + | 7 | Manual only | Grade 10 | 9.8 | MS66 | + | 8 | Item and Box | BGS 10 | 10.0 | F (12-15) | + | 9 | Item and Manual | Grade 1 | 2.0 | XF (40-45) | + | 10 | Box and Manual | Grade 2 | 9.6 | MS60 | + | 13 | Graded CIB | Grade 3 | 3.0 | MS61 | + + #### Genres + Accessories, Action & Adventure, Arcade, Baseball, Beat'em Up, Basketball, Board & Card, Casino, Compilation, Controllers, Dance, Demo & NFR, Extreme Sports, Educational, Fighting, Football, FPS, Golf, Hack and Slash, Horror, Light Gun, Magazine, Mini Games, Movie, Music, Other, Party, Pinball, Platformer, Puzzle, Racing, RPG, Simulation, Shoot'em Up, Soccer, Sports, Strategy, Systems, Third Person Shooter, Trivia, Visual Novel, Wrestling + + #### Console IDs + e.g. `G17` NES, `G13` Super Nintendo, `G11` Wii, `G59` Nintendo Switch. Full table: https://www.pricecharting.com/api-documentation + type: text/markdown diff --git a/bruno/PricechartingAPI/Marketplace API/offer-details.yml b/bruno/PricechartingAPI/Marketplace API/offer-details.yml new file mode 100644 index 0000000..fccacc5 --- /dev/null +++ b/bruno/PricechartingAPI/Marketplace API/offer-details.yml @@ -0,0 +1,79 @@ +info: + name: /offer-details + type: http + seq: 2 + +http: + method: GET + url: https://www.pricecharting.com/api/offer-details?offer-id= + params: + - name: offer-id + value: "" + type: query + description: Required. Offer ID + auth: inherit + +settings: + encodeUrl: true + timeout: 0 + followRedirects: true + maxRedirects: 5 + forwardAuthorizationHeader: false + +docs: |- + Full details for one offer, including buyer shipping info after a sale. + + #### *Response* + + ```json + { + "status":"success", + "buyer": { // buyer's shipping info + "buyer-email":"[email protected]", + "shipping-city":"Anytown", + "shipping-country":"United States", + "shipping-line1":"123 Smith St", + "shipping-line2":"", + "shipping-name":"John Doe", + "shipping-state":"NY", + "shipping-zip":"00000-0000" + }, + "buyer-left-feedback":true, // has buyer posted feedback + "condition":"Normal wear", + "console-name":"Super Nintendo", + "cost-basis":125 + "ended-time":"2017-10-31", // time the listing ended + "has-pictures":true, + "id":7000, + "includes":"Game only", + "is-collection":false, + "is-ended":true, // has offer ended + "is-price-descending":true, // is offer a reverse auction + "is-refunded":false, // has offer been refunded + "is-shipped":true, // has offer been shipped + "is-sold":true, // has offer sold + "max-price":12000, + "min-price":10000, + "offer-id":"vtdsww72uyslgooawzyyijsllm", // unique offer ID + "offer-status":"sold", + "offer-url":"/offer/vtdsww72uyslgooawzyyijsllm", // url for offer + "price":11281, // sales price. $112.81 + "product-name":"Mega Man 7", + "refunded-time":"0001-01-01", // date of refund. zero value + "sale-time":"2017-10-31", + "seller-left-feedback":true, // has seller posted feedback + "shipped-time":"2017-10-31", // date offer shipped. + "shipping-premium":0, // extra paid for shipping internationally + "sku":"", + "start-time":"2017-10-20", + "tracking-number":"9400111234567890000000" // tracking number for shipment + } + ``` + + - `buyer`: `buyer-email`, `shipping-name`, `shipping-line1`, `shipping-line2`, `shipping-city`, `shipping-state`, `shipping-zip`, `shipping-country` + - `buyer-left-feedback`, `seller-left-feedback` + - `id`, `product-name`, `console-name`, `condition`, `includes` + - `price`, `max-price`, `min-price`, `cost-basis`, `shipping-premium` + - `has-pictures`, `is-collection`, `is-ended`, `is-price-descending`, `is-refunded`, `is-shipped`, `is-sold` + - `offer-id`, `offer-status`, `offer-url`, `sku`, `tracking-number` + - `start-time`, `sale-time`, `shipped-time`, `ended-time`, `refunded-time` diff --git a/bruno/PricechartingAPI/Marketplace API/offer-end.yml b/bruno/PricechartingAPI/Marketplace API/offer-end.yml new file mode 100644 index 0000000..bc8c9c7 --- /dev/null +++ b/bruno/PricechartingAPI/Marketplace API/offer-end.yml @@ -0,0 +1,40 @@ +info: + name: /offer-end + type: http + seq: 6 + +http: + method: POST + url: https://www.pricecharting.com/api/offer-end + body: + type: form-urlencoded + data: + - name: t + value: "{{t}}" + description: Required. Access token + - name: offer-id + value: "" + description: Required. Offer ID + +settings: + encodeUrl: true + timeout: 0 + followRedirects: true + maxRedirects: 5 + forwardAuthorizationHeader: false + +docs: |- + End an offer so it can no longer be purchased. For collection items, this removes the item from the collection. + + #### *Response* + + ```json + { + "status":"success", + "offer-id":"vtdsww72uyslgooawzyyijsllm", + "is-ended":true, + "ended-time":"2017-10-31" + } + ``` + + `status`, `offer-id`, `is-ended`, `ended-time` diff --git a/bruno/PricechartingAPI/Marketplace API/offer-feedback.yml b/bruno/PricechartingAPI/Marketplace API/offer-feedback.yml new file mode 100644 index 0000000..816690f --- /dev/null +++ b/bruno/PricechartingAPI/Marketplace API/offer-feedback.yml @@ -0,0 +1,46 @@ +info: + name: /offer-feedback + type: http + seq: 5 + +http: + method: POST + url: https://www.pricecharting.com/api/offer-feedback + body: + type: form-urlencoded + data: + - name: t + value: "{{t}}" + description: Required. Access token + - name: offer-id + value: "" + description: Required. Offer ID + - name: rating + value: "2" + description: "Required. 2 Great | 1 Good | 0 Ok | -1 Bad | -2 Awful" + - name: comment + value: Great buyer + description: Text explaining the rating + +settings: + encodeUrl: true + timeout: 0 + followRedirects: true + maxRedirects: 5 + forwardAuthorizationHeader: false + +docs: |- + Leave feedback on an offer. + + #### *Response* + + ```json + { + "status":"success", + "offer-id":"vtdsww72uyslgooawzyyijsllm", + "rating":2, + "comment":"Great buyer" + } + ``` + + `status`, `offer-id`, `rating`, `comment` diff --git a/bruno/PricechartingAPI/Marketplace API/offer-publish.yml b/bruno/PricechartingAPI/Marketplace API/offer-publish.yml new file mode 100644 index 0000000..9c4c518 --- /dev/null +++ b/bruno/PricechartingAPI/Marketplace API/offer-publish.yml @@ -0,0 +1,139 @@ +info: + name: /offer-publish + type: http + seq: 3 + +http: + method: POST + url: https://www.pricecharting.com/api/offer-publish + body: + type: form-urlencoded + data: + - name: t + value: "{{t}}" + description: Required. Access token + - name: product + value: "9331" + description: PriceCharting product ID (one identifier required) + - name: upc + value: "" + description: UPC (alternative identifier) + disabled: true + - name: asin + value: "" + description: Amazon ASIN (alternative identifier) + disabled: true + - name: epid + value: "" + description: eBay ePID (alternative identifier) + disabled: true + - name: offer-id + value: "" + description: Edit this existing offer instead of creating one + disabled: true + - name: condition-id + value: "1" + description: Required. Condition ID (see folder docs) + - name: price-max + value: "901" + description: Required. Price in pennies (start price if price-min set) + - name: price-min + value: "" + description: Minimum price in pennies; enables 30-day reverse auction + disabled: true + - name: add-to-collection + value: "on" + description: Add to collection instead of listing for sale + disabled: true + - name: quantity + value: "1" + description: Copies owned (collections only) + disabled: true + - name: cost-basis + value: "" + description: Price you paid, in pennies + disabled: true + - name: description + value: "" + description: Max 300 characters + disabled: true + - name: sku + value: 123abc + description: Alphanumeric, max 64 chars, unique among active listings + disabled: true + - name: broken + value: "on" + disabled: true + - name: pristine + value: "on" + description: '"No blemishes"; excludes other tags except new' + disabled: true + - name: scratch + value: "on" + disabled: true + - name: stickers + value: "on" + disabled: true + - name: tear + value: "on" + disabled: true + - name: writing + value: "on" + disabled: true + - name: photo1 + value: "" + description: JPG or PNG URL (photo1..photo6) + disabled: true + - name: photo2 + value: "" + disabled: true + - name: photo3 + value: "" + disabled: true + - name: photo4 + value: "" + disabled: true + - name: photo5 + value: "" + disabled: true + - name: photo6 + value: "" + disabled: true + +settings: + encodeUrl: true + timeout: 0 + followRedirects: true + maxRedirects: 5 + forwardAuthorizationHeader: false + +docs: |- + Publish a new offer, or edit an existing one when `offer-id` is given. + + Provide one identifier: `product`, `upc`, `asin`, `epid`, or `offer-id`. + + Condition tags (`broken`, `pristine`, `scratch`, `stickers`, `tear`, `writing`) are set to `on`. With no tags, the listing shows "Normal wear". + + #### *Response* + + ```json + { + "status":"success" + "cost-basis":125, // price you paid for item + "offer-id":"ccirsewk5mdnoest7xkryagimy", // the unique ID for this new offer + "offer-url":"/offer/ccirsewk5mdnoest7xkryagimy", // url for the new offer + "offer-status":"available", + "product-name":"Metroid", + "console-name":"NES", + "condition-string":"Scratches, Writing", // condition values end users will see + "include-string":"Game, Box", // include values end users will see + "has-pictures":false, // does the listing have a photo + "price":901, + "sku":"123abc", + "is-collection":false, // is the offer in a collection + "start-time":"2017-11-03", // date the offer was listed + "quantity":1, // quantity owned. only supported for collections + } + ``` + + `status`, `offer-id`, `offer-url`, `offer-status`, `product-name`, `console-name`, `condition-string`, `include-string`, `has-pictures`, `price`, `cost-basis`, `sku`, `is-collection`, `quantity`, `start-time` diff --git a/bruno/PricechartingAPI/Marketplace API/offer-refund.yml b/bruno/PricechartingAPI/Marketplace API/offer-refund.yml new file mode 100644 index 0000000..97ce795 --- /dev/null +++ b/bruno/PricechartingAPI/Marketplace API/offer-refund.yml @@ -0,0 +1,40 @@ +info: + name: /offer-refund + type: http + seq: 7 + +http: + method: POST + url: https://www.pricecharting.com/api/offer-refund + body: + type: form-urlencoded + data: + - name: t + value: "{{t}}" + description: Required. Access token + - name: offer-id + value: "" + description: Required. Offer ID + +settings: + encodeUrl: true + timeout: 0 + followRedirects: true + maxRedirects: 5 + forwardAuthorizationHeader: false + +docs: |- + Refund a purchased offer. Payment is returned immediately from the seller's PayPal account to the buyer. + + #### *Response* + + ```json + { + "status":"success", + "offer-id":"vtdsww72uyslgooawzyyijsllm", + "is-refunded":true, + "refunded-time":"2017-10-31" + } + ``` + + `status`, `offer-id`, `is-refunded`, `refunded-time` diff --git a/bruno/PricechartingAPI/Marketplace API/offer-ship.yml b/bruno/PricechartingAPI/Marketplace API/offer-ship.yml new file mode 100644 index 0000000..c7f2b08 --- /dev/null +++ b/bruno/PricechartingAPI/Marketplace API/offer-ship.yml @@ -0,0 +1,45 @@ +info: + name: /offer-ship + type: http + seq: 4 + +http: + method: POST + url: https://www.pricecharting.com/api/offer-ship + body: + type: form-urlencoded + data: + - name: t + value: "{{t}}" + description: Required. Access token + - name: offer-id + value: "" + description: Required. Offer ID + - name: tracking-number + value: "" + description: USPS, FedEx, UPS, or other tracking number + disabled: true + +settings: + encodeUrl: true + timeout: 0 + followRedirects: true + maxRedirects: 5 + forwardAuthorizationHeader: false + +docs: |- + Mark an offer as shipped. A valid tracking number can earn the seller positive feedback if the buyer leaves none, but tracking must show shipment within 3 days and delivery to the buyer's address. + + #### *Response* + + ```json + { + "status":"success", + "offer-id":"vtdsww72uyslgooawzyyijsllm", + "is-shipped":true, + "shipped-time":"2017-10-31", // the date we were notified of shipping + "tracking-number": "901234567890000" + } + ``` + + `status`, `offer-id`, `is-shipped`, `shipped-time`, `tracking-number` diff --git a/bruno/PricechartingAPI/Marketplace API/offers.yml b/bruno/PricechartingAPI/Marketplace API/offers.yml new file mode 100644 index 0000000..53e077e --- /dev/null +++ b/bruno/PricechartingAPI/Marketplace API/offers.yml @@ -0,0 +1,111 @@ +info: + name: /offers + type: http + seq: 1 + +http: + method: GET + url: https://www.pricecharting.com/api/offers?status=available + params: + - name: status + value: available + type: query + description: "Required. available | sold | ended | collection" + - name: seller + value: "" + type: query + description: Seller user ID + disabled: true + - name: buyer + value: "" + type: query + description: Buyer user ID + disabled: true + - name: console + value: G17 + type: query + description: Console ID (e.g. G17 = NES) + disabled: true + - name: condition-id + value: "1" + type: query + description: Condition ID (see folder docs) + disabled: true + - name: genre + value: Football + type: query + description: Genre name (see folder docs) + disabled: true + - name: id + value: "" + type: query + description: PriceCharting product ID + disabled: true + - name: sort + value: lowest-price + type: query + description: "name | starts | lowest-price" + disabled: true + auth: inherit + +settings: + encodeUrl: true + timeout: 0 + followRedirects: true + maxRedirects: 5 + forwardAuthorizationHeader: false + +docs: |- + Returns offers matching the given filters. Throttle requests to the same URL to once per 5 minutes. + + #### *Response* + + ```json + { + "status":"success", + "offers":[ + { + "condition-string":"Normal wear", + "console-name":"NES", + "ended-time":"2017-10-31", + "id":9307, // unique PriceCharting product ID + "include-string":"Game only", + "is-available":false, + "is-ended":true, + "is-shipped":false, + "is-sold":true, // has offer sold + "offer-id":"smzksacsy5i2dsrddxsrlzsp6i", // unique offer Id + "offer-status":"sold", // offer status + "offer-url":"/offer/smzksacsy5i2dsrddxsrlzsp6i", + "price":1473, // $14.73. current price + "product-name":"M.C. Kids", + "sale-time":"2017-10-31", + "shipped-time":"0001-01-01", // zero time since it hasn't shipped + }, + { + "cert-id": "5672930123", // gradeing company unique identifier for graded item + "condition-string":"Scratched,Writing", + "console-name":"NES", + "ended-time":"2017-10-30", + "grade-co-id": 1, // unique ID for the grading company used + "id":9729, + "include-string":"Game, Box, and Manual", + "is-available":false, + "is-ended":true, + "is-shipped":true, + "is-sold":true, + "offer-id":"nw6asacmsbvvoq5yeyrkvzcdky", + "offer-status":"available", + "offer-url":"/offer/nw6asacmsbvvoq5yeyrkvzcdky", + "price":6281, + "product-name":"Shatterhand", + "sale-time":"2017-10-30", + "shipped-time":"2017-10-31", + }, + ], + } + ``` + + `status` and an `offers` list. Each offer: `offer-id`, `offer-status`, `offer-url`, `id`, `product-name`, `console-name`, `condition-string`, `include-string`, `price`, `is-available`, `is-sold`, `is-ended`, `is-shipped`, `sale-time`, `shipped-time`, `ended-time`. + + Graded offers also include `cert-id` and `grade-co-id`. diff --git a/bruno/PricechartingAPI/Prices API/folder.yml b/bruno/PricechartingAPI/Prices API/folder.yml new file mode 100644 index 0000000..b920a4b --- /dev/null +++ b/bruno/PricechartingAPI/Prices API/folder.yml @@ -0,0 +1,14 @@ +info: + name: Prices API + type: folder + seq: 1 + +request: + auth: inherit + +docs: + content: |- + Read-only access to current prices. Historic prices and sales are not available. + + Prices are integer pennies ($17.32 = `1732`). Rate limit: 1 call per second. + type: text/markdown diff --git a/bruno/PricechartingAPI/Prices API/product.yml b/bruno/PricechartingAPI/Prices API/product.yml new file mode 100644 index 0000000..0ca39ce --- /dev/null +++ b/bruno/PricechartingAPI/Prices API/product.yml @@ -0,0 +1,113 @@ +info: + name: /product + type: http + seq: 1 + +http: + method: GET + url: https://www.pricecharting.com/api/product?id=6910 + params: + - name: id + value: "6910" + type: query + description: PriceCharting product ID + - name: upc + value: "045496830434" + type: query + description: UPC barcode + disabled: true + - name: q + value: earthbound + type: query + description: Full text search (best match only) + disabled: true + auth: inherit + +settings: + encodeUrl: true + timeout: 0 + followRedirects: true + maxRedirects: 5 + forwardAuthorizationHeader: false + +docs: |- + This API provides data about a single product. Its response is semantically equivalent to a single row in your downloadable CSV price guide. The JSON key names exactly match the column names. + + #### *Parameters* + + There are several ways to specify which product you want (use one): + + `id=6910` + + **PriceCharting product ID number**\ + This number is available in CSV price guides, provided in API responses or available by hovering your mouse over the product title on an item page on [PriceCharting.com](http://PriceCharting.com) + + `upc=045496830434` + + **UPC**\ + The Universal Product Code is a convenient way to identify products for recent systems. Games in the First and Second Generation rarely have UPCs. + + `q=earthbound` + + **Full text search**\ + Search for a product based on its title and/or console. If multiple products match the search, only the best match is returned. Example queries:\ + \ + `chrono trigger super nintendo`\ + `mario n64`\ + `super mario` + + #### *Response* + + ```json + { + "status": "success", // response status + "cib-price": 42995, // $429.95 + "console-name": "Super Nintendo", + "id": "6910", // unique PriceCharting product ID + "loose-price": 17244, // $172.44 + "new-price": 53000, // $530.00 + "product-name": "EarthBound", + "release-date": "1995-06-05" // 5 June 1995 + } + ``` + + Prices are integer pennies ($17.32 = `1732`). + + **Identifiers / metadata:** `id`, `product-name`, `console-name`, `genre`, `release-date`, `upc`, `asin`, `epid`, `tcg-id` (cards only), `sales-volume` + + **Video game prices** + + | Key | Meaning | + |---|---| + | `loose-price` | Item only, no box or manual | + | `cib-price` | Item with box and manual | + | `new-price` | New, original packaging and seal | + | `graded-price` | New, graded by WATA or VGA | + | `box-only-price` | Original box only | + | `manual-only-price` | Original manual only | + + **Card / comic prices** + + | Key | Cards | Comics | + |---|---|---| + | `loose-price` | Ungraded | Ungraded | + | `cib-price` | Grade 7 / 7.5 | 4.0 / 4.5 | + | `new-price` | Grade 8 / 8.5 | 6.0 / 6.5 | + | `graded-price` | Grade 9 | 8.0 / 8.5 | + | `box-only-price` | Grade 9.5 | 9.2 | + | `manual-only-price` | PSA 10 | 9.8 | + | `bgs-10-price` | BGS 10 | 10.0 | + | `condition-9-price` | Grade 1 | 2.0 | + | `condition-10-price` | Grade 2 | 9.6 | + | `condition-13-price` | Grade 3 | 3.0 | + | `condition-14-price` | Grade 4 | 5.0 | + | `condition-15-price` | Grade 5 | 7.0 | + | `condition-16-price` | Grade 6 | 9.0 | + | `condition-17-price` | CGC 10 | 9.4 | + | `condition-18-price` | SGC 10 | | + | `condition-19-price` | CGC 10 Pristine | | + | `condition-20-price` | BGS 10 Black | | + | `condition-21-price` | TAG 10 | | + | `condition-22-price` | ACE 10 | | + + **Retail:** `gamestop-price`, `retail-loose-buy`, `retail-loose-sell`, `retail-cib-buy`, `retail-cib-sell`, `retail-new-buy`, `retail-new-sell` diff --git a/bruno/PricechartingAPI/Prices API/products.yml b/bruno/PricechartingAPI/Prices API/products.yml new file mode 100644 index 0000000..35a7f0d --- /dev/null +++ b/bruno/PricechartingAPI/Prices API/products.yml @@ -0,0 +1,65 @@ +info: + name: /products + type: http + seq: 2 + +http: + method: GET + url: https://www.pricecharting.com/api/products?q=mario n64 + params: + - name: q + value: mario n64 + type: query + description: Full text search (required) + auth: inherit + +settings: + encodeUrl: true + timeout: 0 + followRedirects: true + maxRedirects: 5 + forwardAuthorizationHeader: false + +docs: |- + There is one way to specify which products you want: + + `q=earthbound` + + **Full text search** + + Search for a product based on its title and/or console. Returns up to the first 20 matching products. + + Example queries: + + `chrono trigger super nintendo` + + `mario n64` + + `charizard #4` + + #### *Response* + + ```json + { + "status": "success", + "products": [ + { + "console-name": "Playstation", + "id": "4801", + "product-name": "Tactics Ogre" + }, + { + "console-name": "GameBoy Advance", + "id": "2611", + "product-name": "Tactics Ogre" + }, + { + "console-name": "PSP", + "id": "30988", + "product-name": "Tactics Ogre: Let Us Cling Together" + } + ] + } + ``` + + `status` and a `products` list; each entry has `id`, `product-name`, `console-name`. diff --git a/bruno/PricechartingAPI/environments/Production.yml b/bruno/PricechartingAPI/environments/Production.yml new file mode 100644 index 0000000..56258a9 --- /dev/null +++ b/bruno/PricechartingAPI/environments/Production.yml @@ -0,0 +1,5 @@ +name: Production +variables: + - name: t + value: "{{process.env.PRICECHARTING_TOKEN}}" + description: API token, loaded from the collection .env file diff --git a/bruno/PricechartingAPI/environments/Test.yml b/bruno/PricechartingAPI/environments/Test.yml new file mode 100644 index 0000000..3bb666e --- /dev/null +++ b/bruno/PricechartingAPI/environments/Test.yml @@ -0,0 +1,5 @@ +name: Test +variables: + - name: t + value: "{{process.env.PRICECHARTING_TEST_TOKEN}}" + diff --git a/bruno/PricechartingAPI/opencollection.yml b/bruno/PricechartingAPI/opencollection.yml new file mode 100644 index 0000000..bfd846b --- /dev/null +++ b/bruno/PricechartingAPI/opencollection.yml @@ -0,0 +1,105 @@ +opencollection: 1.0.0 + +info: + name: Pricecharting API + version: v1 +config: + proxy: + inherit: true + config: + protocol: http + hostname: "" + port: "" + auth: + username: "" + password: "" + bypassProxy: "" + +request: + auth: + type: apikey + key: t + value: "{{t}}" + placement: query + +docs: + content: |- + # PriceCharting API + + Documentation for all PriceCharting APIs, including the Prices API to get current item prices and the Marketplace API to automate all aspects of finding and selling items on the Marketplace. + + Source: https://www.pricecharting.com/api-documentation + + ## Overview + + - Requests are made over HTTPS + - Responses are returned in JSON format + - Responses include liberal CORS headers to facilitate cross-site requests + - Authentication with a static, shared secret + + ## Authentication + + APIs are a premium tool. You must have a paid subscription to access the API. + + Each subscription has a unique, 40-character token associated with it. You can find this token by visiting the Subscription page and clicking the "API/Download" button. + + Set your own token in the collection `.env` file as `PRICECHARTING_TOKEN`. + Set a test token as `PRICECHARTING_TEST_TOKEN` + + Each API call is authenticated by including this token as the `t` parameter in the HTTP request. This token is specific to your guide and grants access to the data you've purchased. Please keep this token private. + + ## Make a Request + + Make an HTTP request to the base URL `https://www.pricecharting.com` plus the path for the API you want. The most common is `/api/product`. Be sure to include a `t` parameter with your access token and any other parameters required by the API itself. + + Requests use `GET` or `POST` methods. As a general rule, APIs that display data only use `GET` and APIs that create or change data use `POST`. + + - Each API response is a JSON object. + - Dates are encoded as `YYYY-MM-DD` strings. + - Prices are an integer number of pennies. For example, $17.32 is encoded as `1732`. + - Booleans are encoded as booleans. + - All other keys are encoded as strings. + + ## Error Handling + + Each JSON object contains a `status` key whose value is either `success` or `error`. If the status is `success`, the request completed successfully and the HTTP status code is 200. + + If the status is `error`, there is also an `error-message` key whose value describes what went wrong. The HTTP status code falls in the 400 or 500 range. + + ## API Limits + + The API is limited to 1 call every second. Any more than that and your calls will be blocked, and your account permissions revoked if it persists. + + CSV calls are limited to one every 10 minutes. If you need lots of data on multiple items, download a CSV to get thousands of items in one request. + + ## Usage & Attribution + + The API and CSV data are licensed for internal use only. Sharing price data with a third party, or making it available within an application or service used by others, requires a commercial license and express written permission from PriceCharting. + + If you have approval to share price data via a Commercial Agreement, PriceCharting prefers attribution of either a logo or text linkback to the specific product page: + + `https://www.pricecharting.com/game/{PriceCharting_ID}` + + - Data can and should be cached/stored on your servers. Instead of making API requests for all of your user requests, store the API/CSV results in your database and serve those requests to your users. + - All data gathered from the API or CSV must be purged after your subscription has ended. + + ## Download Data via CSV File + + A CSV download with all the data included is a more efficient way to update lots of data points at one time. + + - CSV files are generated once every 24 hours, so there's no need to download more than once per day. + - CSV column names match the Prices API key names. + - CSV price columns are in USD with two decimal places. + - CSV download is only available to Legendary subscribers. Visit the Subscriptions page and click the "API/Download" button. + type: text/markdown +bundled: false +extensions: + bruno: + ignore: + - node_modules + - .git + presets: + request: + type: http + url: https://www.pricecharting.com/api + defaultEnvironment: Production diff --git a/open_api/pricecharting.yaml b/open_api/pricecharting.yaml new file mode 100644 index 0000000..31d2cce --- /dev/null +++ b/open_api/pricecharting.yaml @@ -0,0 +1,1020 @@ +openapi: 3.1.0 + +info: + title: PriceCharting API + version: v1 + description: |- + APIs for PriceCharting, including the Prices API to get current item prices and the + Marketplace API to automate finding and selling items on the Marketplace. + + - Requests are made over HTTPS and responses are JSON with liberal CORS headers. + - Authenticate with your 40-character subscription token as the `t` parameter. + `GET` requests take it in the query string; `POST` requests take it in the form body. + - Dates are `YYYY-MM-DD` strings. Zero-value dates such as `0001-01-01` mean "not set". + - Prices are integer pennies ($17.32 = `1732`). + - Every response has a `status` of `success` or `error`. Errors use a 4xx/5xx HTTP code + and include an `error-message`. + + **Limits:** 1 call per second. Throttle `/api/offers` requests to the same URL to once + per 5 minutes. CSV downloads are limited to one every 10 minutes. + + **Usage:** API and CSV data are licensed for internal use only. Sharing data with third + parties requires a commercial license. All data must be purged when your subscription ends. + +externalDocs: + url: https://www.pricecharting.com/api-documentation + +servers: + - url: https://www.pricecharting.com + +security: + - token: [] + +tags: + - name: Prices + description: Read-only access to current prices. Historic prices and sales are not supported. + - name: Marketplace + description: Automate selling on the PriceCharting Marketplace. + +paths: + /api/product: + get: + tags: [Prices] + operationId: getProduct + summary: Get a single product + description: |- + Returns data about a single product. The response is equivalent to a single row in the + CSV price guide, and the JSON keys match the CSV column names. + + Specify the product with exactly one of `id`, `upc`, or `q`. + parameters: + - name: id + in: query + description: PriceCharting product ID. + schema: + type: string + example: "6910" + - name: upc + in: query + description: UPC barcode. First and second generation games rarely have one. + schema: + type: string + example: "045496830434" + - name: q + in: query + description: Full text search on title and/or console. Only the best match is returned. + schema: + type: string + example: earthbound + responses: + "200": + description: The matching product. + content: + application/json: + schema: + $ref: "#/components/schemas/Product" + example: + status: success + cib-price: 42995 + console-name: Super Nintendo + id: "6910" + loose-price: 17244 + new-price: 53000 + product-name: EarthBound + release-date: "1995-06-05" + "4XX": + $ref: "#/components/responses/Error" + "5XX": + $ref: "#/components/responses/Error" + + /api/products: + get: + tags: [Prices] + operationId: searchProducts + summary: Search products + description: Returns up to the first 20 products matching a full text search. + parameters: + - name: q + in: query + required: true + description: Full text search on title and/or console. + schema: + type: string + examples: + console: + value: chrono trigger super nintendo + short: + value: mario n64 + card: + value: "charizard #4" + responses: + "200": + description: Matching products. + content: + application/json: + schema: + $ref: "#/components/schemas/ProductsResponse" + example: + status: success + products: + - console-name: Playstation + id: "4801" + product-name: Tactics Ogre + - console-name: GameBoy Advance + id: "2611" + product-name: Tactics Ogre + - console-name: PSP + id: "30988" + product-name: "Tactics Ogre: Let Us Cling Together" + "4XX": + $ref: "#/components/responses/Error" + "5XX": + $ref: "#/components/responses/Error" + + /api/offers: + get: + tags: [Marketplace] + operationId: listOffers + summary: List offers + description: Returns offers matching the given filters. + parameters: + - name: status + in: query + required: true + schema: + type: string + enum: [available, sold, ended, collection] + - name: seller + in: query + description: Seller user ID. + schema: + type: string + example: 7cgdyu5ynzos3mxwhfh46xj3f4 + - name: buyer + in: query + description: Buyer user ID. + schema: + type: string + example: 7cgdyu5ynzos3mxwhfh46xj3f4 + - name: console + in: query + description: Console ID, e.g. `G17` for NES. + schema: + type: string + example: G17 + - name: condition-id + in: query + description: Condition ID. See `ConditionId`. + schema: + $ref: "#/components/schemas/ConditionId" + - name: genre + in: query + description: Genre name, e.g. `Football`. + schema: + type: string + example: Football + - name: id + in: query + description: PriceCharting product ID. + schema: + type: string + example: "6910" + - name: sort + in: query + description: "`name` (alphabetical), `starts` (newest listings), or `lowest-price`." + schema: + type: string + enum: [name, starts, lowest-price] + responses: + "200": + description: Matching offers. + content: + application/json: + schema: + $ref: "#/components/schemas/OffersResponse" + example: + status: success + offers: + - condition-string: Normal wear + console-name: NES + ended-time: "2017-10-31" + id: 9307 + include-string: Game only + is-available: false + is-ended: true + is-shipped: false + is-sold: true + offer-id: smzksacsy5i2dsrddxsrlzsp6i + offer-status: sold + offer-url: /offer/smzksacsy5i2dsrddxsrlzsp6i + price: 1473 + product-name: M.C. Kids + sale-time: "2017-10-31" + shipped-time: "0001-01-01" + - cert-id: "5672930123" + condition-string: Scratched,Writing + console-name: NES + ended-time: "2017-10-30" + grade-co-id: 1 + id: 9729 + include-string: Game, Box, and Manual + is-available: false + is-ended: true + is-shipped: true + is-sold: true + offer-id: nw6asacmsbvvoq5yeyrkvzcdky + offer-status: sold + offer-url: /offer/nw6asacmsbvvoq5yeyrkvzcdky + price: 6281 + product-name: Shatterhand + sale-time: "2017-10-30" + shipped-time: "2017-10-31" + "4XX": + $ref: "#/components/responses/Error" + "5XX": + $ref: "#/components/responses/Error" + + /api/offer-details: + get: + tags: [Marketplace] + operationId: getOfferDetails + summary: Get offer details + description: Full details for one offer, including buyer shipping info after a sale. + parameters: + - name: offer-id + in: query + required: true + schema: + type: string + example: vtdsww72uyslgooawzyyijsllm + responses: + "200": + description: The offer. + content: + application/json: + schema: + $ref: "#/components/schemas/OfferDetails" + example: + status: success + buyer: + buyer-email: buyer@example.com + shipping-city: Anytown + shipping-country: United States + shipping-line1: 123 Smith St + shipping-line2: "" + shipping-name: John Doe + shipping-state: NY + shipping-zip: 00000-0000 + buyer-left-feedback: true + condition: Normal wear + console-name: Super Nintendo + cost-basis: 125 + ended-time: "2017-10-31" + has-pictures: true + id: 7000 + includes: Game only + is-collection: false + is-ended: true + is-price-descending: true + is-refunded: false + is-shipped: true + is-sold: true + max-price: 12000 + min-price: 10000 + offer-id: vtdsww72uyslgooawzyyijsllm + offer-status: sold + offer-url: /offer/vtdsww72uyslgooawzyyijsllm + price: 11281 + product-name: Mega Man 7 + refunded-time: "0001-01-01" + sale-time: "2017-10-31" + seller-left-feedback: true + shipped-time: "2017-10-31" + shipping-premium: 0 + sku: "" + start-time: "2017-10-20" + tracking-number: "9400111234567890000000" + "4XX": + $ref: "#/components/responses/Error" + "5XX": + $ref: "#/components/responses/Error" + + /api/offer-publish: + post: + tags: [Marketplace] + operationId: publishOffer + summary: Publish or edit an offer + description: |- + Publishes a new offer, or edits an existing one when `offer-id` is given. + + Provide exactly one identifier: `product`, `upc`, `asin`, `epid`, or `offer-id`. + + Condition tags (`broken`, `pristine`, `scratch`, `stickers`, `tear`, `writing`) are + set to `on`. With no tags, the listing shows "Normal wear". `pristine` displays as + "No blemishes" and excludes all other tags except `new`. + security: [] + requestBody: + required: true + content: + application/x-www-form-urlencoded: + schema: + type: object + required: [t, condition-id, price-max] + properties: + t: + $ref: "#/components/schemas/Token" + product: + type: string + description: PriceCharting product ID. Creates a new listing. + example: "9331" + upc: + type: string + description: UPC. Creates a new listing. + example: "045496630348" + asin: + type: string + description: Amazon ASIN. Creates a new listing. + example: B00004SVYF + epid: + type: string + description: eBay ePID. Creates a new listing. + example: "6088" + offer-id: + type: string + description: Existing offer ID. Edits that offer. + example: vtdsww72uyslgooawzyyijsllm + price-max: + type: integer + description: Price in pennies. Starting price when `price-min` is also set. + example: 901 + price-min: + type: integer + description: >- + Minimum price in pennies. Makes the listing a reverse auction whose price + drops over 30 days from `price-max` until it reaches `price-min` or sells. + condition-id: + $ref: "#/components/schemas/ConditionId" + add-to-collection: + $ref: "#/components/schemas/On" + cost-basis: + type: integer + description: Price you paid, in pennies. + description: + type: string + maxLength: 300 + sku: + type: string + maxLength: 64 + pattern: "^[A-Za-z0-9]*$" + description: Internal SKU. Must be unique among active listings. + example: 123abc + quantity: + type: integer + default: 1 + description: Copies owned. Collections only. + broken: + $ref: "#/components/schemas/On" + pristine: + $ref: "#/components/schemas/On" + scratch: + $ref: "#/components/schemas/On" + stickers: + $ref: "#/components/schemas/On" + tear: + $ref: "#/components/schemas/On" + writing: + $ref: "#/components/schemas/On" + photo1: + $ref: "#/components/schemas/PhotoUrl" + photo2: + $ref: "#/components/schemas/PhotoUrl" + photo3: + $ref: "#/components/schemas/PhotoUrl" + photo4: + $ref: "#/components/schemas/PhotoUrl" + photo5: + $ref: "#/components/schemas/PhotoUrl" + photo6: + $ref: "#/components/schemas/PhotoUrl" + responses: + "200": + description: The published offer. + content: + application/json: + schema: + $ref: "#/components/schemas/PublishResponse" + example: + status: success + cost-basis: 125 + offer-id: ccirsewk5mdnoest7xkryagimy + offer-url: /offer/ccirsewk5mdnoest7xkryagimy + offer-status: available + product-name: Metroid + console-name: NES + condition-string: Scratches, Writing + include-string: Game, Box + has-pictures: false + price: 901 + sku: 123abc + is-collection: false + start-time: "2017-11-03" + quantity: 1 + "4XX": + $ref: "#/components/responses/Error" + "5XX": + $ref: "#/components/responses/Error" + + /api/offer-feedback: + post: + tags: [Marketplace] + operationId: leaveOfferFeedback + summary: Leave feedback on an offer + security: [] + requestBody: + required: true + content: + application/x-www-form-urlencoded: + schema: + type: object + required: [t, offer-id, rating] + properties: + t: + $ref: "#/components/schemas/Token" + offer-id: + type: string + example: vtdsww72uyslgooawzyyijsllm + rating: + $ref: "#/components/schemas/Rating" + comment: + type: string + example: Great buyer + responses: + "200": + description: The feedback left. + content: + application/json: + schema: + $ref: "#/components/schemas/FeedbackResponse" + example: + status: success + offer-id: vtdsww72uyslgooawzyyijsllm + rating: 2 + comment: Great buyer + "4XX": + $ref: "#/components/responses/Error" + "5XX": + $ref: "#/components/responses/Error" + + /api/offer-ship: + post: + tags: [Marketplace] + operationId: shipOffer + summary: Mark an offer as shipped + description: >- + A valid tracking number can earn the seller positive feedback if the buyer leaves none, + but tracking must show shipment within 3 days and delivery to the buyer's address. + security: [] + requestBody: + required: true + content: + application/x-www-form-urlencoded: + schema: + type: object + required: [t, offer-id] + properties: + t: + $ref: "#/components/schemas/Token" + offer-id: + type: string + example: vtdsww72uyslgooawzyyijsllm + tracking-number: + type: string + description: USPS, FedEx, UPS, or other tracking number. Omit if unavailable. + example: "901234567890000" + responses: + "200": + description: The shipped offer. + content: + application/json: + schema: + $ref: "#/components/schemas/ShipResponse" + example: + status: success + offer-id: vtdsww72uyslgooawzyyijsllm + is-shipped: true + shipped-time: "2017-10-31" + tracking-number: "901234567890000" + "4XX": + $ref: "#/components/responses/Error" + "5XX": + $ref: "#/components/responses/Error" + + /api/offer-end: + post: + tags: [Marketplace] + operationId: endOffer + summary: End an offer + description: >- + Ends an offer so it can no longer be purchased. For collection items, this removes the + item from the collection. + security: [] + requestBody: + required: true + content: + application/x-www-form-urlencoded: + schema: + $ref: "#/components/schemas/OfferIdForm" + responses: + "200": + description: The ended offer. + content: + application/json: + schema: + $ref: "#/components/schemas/EndResponse" + example: + status: success + offer-id: vtdsww72uyslgooawzyyijsllm + is-ended: true + ended-time: "2017-10-31" + "4XX": + $ref: "#/components/responses/Error" + "5XX": + $ref: "#/components/responses/Error" + + /api/offer-refund: + post: + tags: [Marketplace] + operationId: refundOffer + summary: Refund a purchased offer + description: Payment is returned immediately from the seller's PayPal account to the buyer. + security: [] + requestBody: + required: true + content: + application/x-www-form-urlencoded: + schema: + $ref: "#/components/schemas/OfferIdForm" + responses: + "200": + description: The refunded offer. + content: + application/json: + schema: + $ref: "#/components/schemas/RefundResponse" + example: + status: success + offer-id: vtdsww72uyslgooawzyyijsllm + is-refunded: true + refunded-time: "2017-10-31" + "4XX": + $ref: "#/components/responses/Error" + "5XX": + $ref: "#/components/responses/Error" + +components: + securitySchemes: + token: + type: apiKey + in: query + name: t + description: 40-character subscription token from the Subscriptions page ("API/Download"). + + responses: + Error: + description: The request failed. + content: + application/json: + schema: + $ref: "#/components/schemas/Error" + + schemas: + Token: + type: string + description: 40-character subscription token. + minLength: 40 + maxLength: 40 + + On: + type: string + enum: ["on"] + + PhotoUrl: + type: string + format: uri + description: JPG or PNG photo URL. + + Date: + type: string + description: "`YYYY-MM-DD`. `0001-01-01` means not set." + example: "2017-10-31" + + Pennies: + type: integer + description: Price in pennies. + + ConditionId: + type: integer + enum: [1, 2, 3, 5, 6, 7, 8, 9, 10, 13] + description: |- + | ID | Video Games | Cards | Comics | Coins | + |---|---|---|---|---| + | 1 | Loose | Ungraded | Ungraded | Ungraded | + | 2 | New & Sealed | Grade 8 | 6.0 | AU (50-58) | + | 3 | CIB | Grade 7 | 4.0 | VF (20-35) | + | 5 | Graded | Grade 9 | 8.0 | MS62 | + | 6 | Box only | Grade 9.5 | 9.2 | MS64 | + | 7 | Manual only | Grade 10 | 9.8 | MS66 | + | 8 | Item and Box | BGS 10 | 10.0 | F (12-15) | + | 9 | Item and Manual | Grade 1 | 2.0 | XF (40-45) | + | 10 | Box and Manual | Grade 2 | 9.6 | MS60 | + | 13 | Graded CIB | Grade 3 | 3.0 | MS61 | + + Rating: + type: integer + enum: [2, 1, 0, -1, -2] + description: "`2` Great, `1` Good, `0` Ok, `-1` Bad, `-2` Awful." + + OfferStatus: + type: string + enum: [available, sold, ended, pending, collection] + description: "`pending` means a vacation hold or payment issue; see `pending-reason`." + + Status: + type: string + enum: [success, error] + + Error: + type: object + required: [status, error-message] + properties: + status: + type: string + const: error + error-message: + type: string + + Product: + type: object + description: >- + Price keys mean different conditions for video games, trading cards, and comics. + Descriptions list video games / cards / comics. + properties: + status: + $ref: "#/components/schemas/Status" + id: + type: string + description: PriceCharting product ID. + product-name: + type: string + console-name: + type: string + genre: + type: string + example: RPG + release-date: + $ref: "#/components/schemas/Date" + upc: + type: string + asin: + type: string + description: Amazon ASIN. + epid: + type: string + description: eBay ePID. + tcg-id: + type: string + description: TCGplayer ID. Trading cards only. + sales-volume: + type: integer + description: Yearly units sold. + loose-price: + $ref: "#/components/schemas/Pennies" + description: Item only / ungraded / ungraded. + cib-price: + $ref: "#/components/schemas/Pennies" + description: Item with box and manual / grade 7-7.5 / 4.0-4.5. + new-price: + $ref: "#/components/schemas/Pennies" + description: New and sealed / grade 8-8.5 / 6.0-6.5. + graded-price: + $ref: "#/components/schemas/Pennies" + description: New, graded by WATA or VGA / grade 9 / 8.0-8.5. + box-only-price: + $ref: "#/components/schemas/Pennies" + description: Box only / grade 9.5 / 9.2. + manual-only-price: + $ref: "#/components/schemas/Pennies" + description: Manual only / PSA 10 / 9.8. + bgs-10-price: + $ref: "#/components/schemas/Pennies" + description: Cards BGS 10 / comics 10.0. + condition-9-price: + $ref: "#/components/schemas/Pennies" + description: Cards grade 1 / comics 2.0. + condition-10-price: + $ref: "#/components/schemas/Pennies" + description: Cards grade 2 / comics 9.6. + condition-13-price: + $ref: "#/components/schemas/Pennies" + description: Cards grade 3 / comics 3.0. + condition-14-price: + $ref: "#/components/schemas/Pennies" + description: Cards grade 4 / comics 5.0. + condition-15-price: + $ref: "#/components/schemas/Pennies" + description: Cards grade 5 / comics 7.0. + condition-16-price: + $ref: "#/components/schemas/Pennies" + description: Cards grade 6 / comics 9.0. + condition-17-price: + $ref: "#/components/schemas/Pennies" + description: Cards CGC 10 / comics 9.4. + condition-18-price: + $ref: "#/components/schemas/Pennies" + description: Cards SGC 10. + condition-19-price: + $ref: "#/components/schemas/Pennies" + description: Cards CGC 10 Pristine. + condition-20-price: + $ref: "#/components/schemas/Pennies" + description: Cards BGS 10 Black. + condition-21-price: + $ref: "#/components/schemas/Pennies" + description: Cards TAG 10. + condition-22-price: + $ref: "#/components/schemas/Pennies" + description: Cards ACE 10. + gamestop-price: + $ref: "#/components/schemas/Pennies" + description: GameStop pre-owned price. Only for consoles GameStop sells or trades. + retail-loose-buy: + $ref: "#/components/schemas/Pennies" + retail-loose-sell: + $ref: "#/components/schemas/Pennies" + retail-cib-buy: + $ref: "#/components/schemas/Pennies" + retail-cib-sell: + $ref: "#/components/schemas/Pennies" + retail-new-buy: + $ref: "#/components/schemas/Pennies" + retail-new-sell: + $ref: "#/components/schemas/Pennies" + + ProductSummary: + type: object + properties: + id: + type: string + product-name: + type: string + console-name: + type: string + + ProductsResponse: + type: object + properties: + status: + $ref: "#/components/schemas/Status" + products: + type: array + maxItems: 20 + items: + $ref: "#/components/schemas/ProductSummary" + + Offer: + type: object + properties: + offer-id: + type: string + offer-status: + $ref: "#/components/schemas/OfferStatus" + offer-url: + type: string + description: Relative URL. Prepend `https://www.pricecharting.com`. + id: + type: integer + description: PriceCharting product ID. + product-name: + type: string + console-name: + type: string + condition-string: + type: string + include-string: + type: string + price: + $ref: "#/components/schemas/Pennies" + description: Current price, or sale price (including any shipping premium) if sold. + is-available: + type: boolean + is-sold: + type: boolean + is-ended: + type: boolean + is-shipped: + type: boolean + sale-time: + $ref: "#/components/schemas/Date" + shipped-time: + $ref: "#/components/schemas/Date" + ended-time: + $ref: "#/components/schemas/Date" + cert-id: + type: string + description: Grading company certificate number. Graded offers only. + grade-co-id: + type: integer + description: Grading company ID. Graded offers only. + + OffersResponse: + type: object + properties: + status: + $ref: "#/components/schemas/Status" + offers: + type: array + items: + $ref: "#/components/schemas/Offer" + + Buyer: + type: object + properties: + buyer-email: + type: string + shipping-name: + type: string + shipping-line1: + type: string + shipping-line2: + type: string + shipping-city: + type: string + shipping-state: + type: string + shipping-zip: + type: string + shipping-country: + type: string + + OfferDetails: + type: object + properties: + status: + $ref: "#/components/schemas/Status" + buyer: + $ref: "#/components/schemas/Buyer" + buyer-left-feedback: + type: boolean + seller-left-feedback: + type: boolean + id: + type: integer + product-name: + type: string + console-name: + type: string + condition: + type: string + includes: + type: string + cost-basis: + $ref: "#/components/schemas/Pennies" + price: + $ref: "#/components/schemas/Pennies" + max-price: + $ref: "#/components/schemas/Pennies" + min-price: + $ref: "#/components/schemas/Pennies" + shipping-premium: + $ref: "#/components/schemas/Pennies" + description: Extra paid by the buyer for international shipping. + has-pictures: + type: boolean + is-collection: + type: boolean + is-ended: + type: boolean + is-price-descending: + type: boolean + description: Whether the offer is a reverse auction. + is-refunded: + type: boolean + is-shipped: + type: boolean + is-sold: + type: boolean + offer-id: + type: string + offer-status: + $ref: "#/components/schemas/OfferStatus" + offer-url: + type: string + sku: + type: string + description: Only returned to the seller. + tracking-number: + type: string + start-time: + $ref: "#/components/schemas/Date" + sale-time: + $ref: "#/components/schemas/Date" + shipped-time: + $ref: "#/components/schemas/Date" + ended-time: + $ref: "#/components/schemas/Date" + refunded-time: + $ref: "#/components/schemas/Date" + + PublishResponse: + type: object + properties: + status: + $ref: "#/components/schemas/Status" + offer-id: + type: string + offer-url: + type: string + offer-status: + $ref: "#/components/schemas/OfferStatus" + product-name: + type: string + console-name: + type: string + condition-string: + type: string + include-string: + type: string + has-pictures: + type: boolean + price: + $ref: "#/components/schemas/Pennies" + cost-basis: + $ref: "#/components/schemas/Pennies" + sku: + type: string + is-collection: + type: boolean + quantity: + type: integer + start-time: + $ref: "#/components/schemas/Date" + + OfferIdForm: + type: object + required: [t, offer-id] + properties: + t: + $ref: "#/components/schemas/Token" + offer-id: + type: string + example: vtdsww72uyslgooawzyyijsllm + + FeedbackResponse: + type: object + properties: + status: + $ref: "#/components/schemas/Status" + offer-id: + type: string + rating: + $ref: "#/components/schemas/Rating" + comment: + type: string + + ShipResponse: + type: object + properties: + status: + $ref: "#/components/schemas/Status" + offer-id: + type: string + is-shipped: + type: boolean + shipped-time: + $ref: "#/components/schemas/Date" + tracking-number: + type: string + + EndResponse: + type: object + properties: + status: + $ref: "#/components/schemas/Status" + offer-id: + type: string + is-ended: + type: boolean + ended-time: + $ref: "#/components/schemas/Date" + + RefundResponse: + type: object + properties: + status: + $ref: "#/components/schemas/Status" + offer-id: + type: string + is-refunded: + type: boolean + refunded-time: + $ref: "#/components/schemas/Date" From b67cd224a8b18662b22e15939a475854a8257ec7 Mon Sep 17 00:00:00 2001 From: Aaron <7063649+ahcode0919@users.noreply.github.com> Date: Mon, 2 Nov 2026 00:50:42 -0800 Subject: [PATCH 2/3] Update docs --- .gitignore | 1 + README.md | 13 ++++++++++--- .../PricechartingAPI/Marketplace API/offer-end.yml | 1 + .../Marketplace API/offer-feedback.yml | 1 + .../Marketplace API/offer-publish.yml | 1 + .../Marketplace API/offer-refund.yml | 1 + .../PricechartingAPI/Marketplace API/offer-ship.yml | 1 + 7 files changed, 16 insertions(+), 3 deletions(-) diff --git a/.gitignore b/.gitignore index e599525..2d72a4a 100644 --- a/.gitignore +++ b/.gitignore @@ -133,3 +133,4 @@ dmypy.json # Claude .claude/*.local.* +CLAUDE.md \ No newline at end of file diff --git a/README.md b/README.md index 402f3dd..dcfdeb5 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# Python Project Template ![](https://github.com/ahcode0919/python-project-template/actions/workflows/ci.yml/badge.svg?branch=main) +# PyPricecharting API Client ![](https://github.com/ahcode0919/pypricecharting/actions/workflows/ci.yml/badge.svg?branch=main) -Baseline Python project template +Pricecharting API Client written in Python ## Setup @@ -18,7 +18,7 @@ Note: Project uses `uv` and `just` to manage project configuration and commands * Install Docker * Install VSCode * Open project folder in VS Code -* Install recommended extensions +* Optional - Install recommended extensions * Reopen in container using Remote Development Container menu ## Project Commands @@ -33,3 +33,10 @@ Note: Project uses `uv` and `just` to manage project configuration and commands ## Usage * Usage Notes + +## Supporting Files + +Project contains an OpenAPI spec and a Bruno project for easy testing and mocking + +* `./bruno` - Bruno project +* `./open_api` - OpenApi spec diff --git a/bruno/PricechartingAPI/Marketplace API/offer-end.yml b/bruno/PricechartingAPI/Marketplace API/offer-end.yml index bc8c9c7..a0aa3aa 100644 --- a/bruno/PricechartingAPI/Marketplace API/offer-end.yml +++ b/bruno/PricechartingAPI/Marketplace API/offer-end.yml @@ -15,6 +15,7 @@ http: - name: offer-id value: "" description: Required. Offer ID + auth: none settings: encodeUrl: true diff --git a/bruno/PricechartingAPI/Marketplace API/offer-feedback.yml b/bruno/PricechartingAPI/Marketplace API/offer-feedback.yml index 816690f..614ade8 100644 --- a/bruno/PricechartingAPI/Marketplace API/offer-feedback.yml +++ b/bruno/PricechartingAPI/Marketplace API/offer-feedback.yml @@ -21,6 +21,7 @@ http: - name: comment value: Great buyer description: Text explaining the rating + auth: none settings: encodeUrl: true diff --git a/bruno/PricechartingAPI/Marketplace API/offer-publish.yml b/bruno/PricechartingAPI/Marketplace API/offer-publish.yml index 9c4c518..2a85055 100644 --- a/bruno/PricechartingAPI/Marketplace API/offer-publish.yml +++ b/bruno/PricechartingAPI/Marketplace API/offer-publish.yml @@ -99,6 +99,7 @@ http: - name: photo6 value: "" disabled: true + auth: none settings: encodeUrl: true diff --git a/bruno/PricechartingAPI/Marketplace API/offer-refund.yml b/bruno/PricechartingAPI/Marketplace API/offer-refund.yml index 97ce795..585bd65 100644 --- a/bruno/PricechartingAPI/Marketplace API/offer-refund.yml +++ b/bruno/PricechartingAPI/Marketplace API/offer-refund.yml @@ -15,6 +15,7 @@ http: - name: offer-id value: "" description: Required. Offer ID + auth: none settings: encodeUrl: true diff --git a/bruno/PricechartingAPI/Marketplace API/offer-ship.yml b/bruno/PricechartingAPI/Marketplace API/offer-ship.yml index c7f2b08..b04a88a 100644 --- a/bruno/PricechartingAPI/Marketplace API/offer-ship.yml +++ b/bruno/PricechartingAPI/Marketplace API/offer-ship.yml @@ -19,6 +19,7 @@ http: value: "" description: USPS, FedEx, UPS, or other tracking number disabled: true + auth: none settings: encodeUrl: true From b3114deda1a697dd749d576efeddfec66cee0c04 Mon Sep 17 00:00:00 2001 From: Aaron <7063649+ahcode0919@users.noreply.github.com> Date: Mon, 2 Nov 2026 00:59:42 -0800 Subject: [PATCH 3/3] Update codespell --- pyproject.toml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/pyproject.toml b/pyproject.toml index be48d7d..5674f48 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -14,6 +14,9 @@ dev = [ ] [tool.codespell] +# Product names used in PriceCharting's example data. +ignore-words-list = "gameboy" + [tool.pytest.ini_options] pythonpath = ["."]