{ "openapi": "3.0.1", "info": { "title": "Indigo Books Scraper — Chapters & Coles Prices, ISBN, Stock", "description": "Scrape indigo.ca (Indigo, Chapters, Coles): books, eBooks and gifts by keyword, ISBN, bestseller list or link. Price vs list price, ISBN-10/13 for every format, authors, publisher, online stock, live per-store stock across ~160 Canadian stores, ratings and reviews. No login.", "version": "0.1", "x-build-id": "lFdMCxCMUx7y3OFz9" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/yugenox~indigo-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-yugenox-indigo-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/yugenox~indigo-scraper/runs": { "post": { "operationId": "runs-sync-yugenox-indigo-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/yugenox~indigo-scraper/run-sync": { "post": { "operationId": "run-sync-yugenox-indigo-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": { "searchTerms": { "title": "🔎 Search terms", "type": "array", "description": "Titles, authors, series or keywords — what you would type into the indigo.ca search box. Each term is scraped separately.", "items": { "type": "string" } }, "isbns": { "title": "📚 ISBNs or barcodes", "type": "array", "description": "ISBN-13, ISBN-10 (hyphens are fine) or UPC barcodes. Each code returns that exact edition — ideal for checking a list of books against Indigo's price and stock.", "items": { "type": "string" } }, "collections": { "title": "🏆 Collections & bestseller lists", "type": "array", "description": "Collection names or indigo.ca/collections/… links, e.g. new-york-times-bestsellers, globe-and-mail-bestsellers, heathers-picks, canadian-authors, most-anticipated-books, new-this-week-books, bestselling-books, kids-books, booker-prize, kobo-sale.", "items": { "type": "string" } }, "startUrls": { "title": "🔗 indigo.ca links", "type": "array", "description": "Product pages, collection pages or search result pages from indigo.ca. A product link with ?variant=… returns that exact format.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxItems": { "title": "Max results in total", "minimum": 0, "type": "integer", "description": "Stop the whole run after this many rows. 0 = no overall limit.", "default": 0 }, "maxItemsPerQuery": { "title": "Max results per search / collection", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Upper limit for each search term or collection. Indigo shows at most 10,000 results for one search; ask for more and the actor splits the search by price, format and language to go past that.", "default": 100 }, "sortBy": { "title": "Sort by", "enum": [ "relevance", "price_asc", "price_desc", "newest", "release_date", "rating" ], "type": "string", "description": "Order of search and collection results, as on the website.", "default": "relevance" }, "category": { "title": "Department", "enum": [ "any", "books", "kids-books", "ebooks", "gifts", "toys-baby", "lifestyle" ], "type": "string", "description": "Limit searches to one department. Picking a department without any search terms scrapes the department itself.", "default": "any" }, "formats": { "title": "Formats", "type": "array", "description": "Only these formats. Leave empty for all.", "items": { "type": "string", "enum": [ "Hardcover", "Paperback", "Mass Market Paperback", "Kobo eBook", "Kobo Audiobook", "Audiobook", "Large Print", "Board Book", "Picture Book", "Boxed Set", "Spiral Bound Book", "Colouring Book", "Sticker Book", "Book & Audio", "Map", "Other" ] } }, "languages": { "title": "Languages", "type": "array", "description": "Only books in these languages, e.g. English, French, Spanish; Castilian, German. Leave empty for all.", "items": { "type": "string" } }, "featured": { "title": "Featured labels", "type": "array", "description": "Only products carrying one of these labels.", "items": { "type": "string", "enum": [ "Canadian", "Heather's Pick", "Staff Pick", "New York Times Bestseller", "Globe and Mail Bestseller", "Best Books of the Year", "Indigo Exclusive", "Signed Edition", "Large Print", "Eco Friendly" ] } }, "minPrice": { "title": "Min price (CAD)", "minimum": 0, "type": "integer", "description": "Only products at or above this price." }, "maxPrice": { "title": "Max price (CAD)", "minimum": 0, "type": "integer", "description": "Only products at or below this price." }, "minRating": { "title": "Min star rating", "minimum": 0, "maximum": 5, "type": "integer", "description": "Only products rated at least this many stars (1–5)." }, "onSaleOnly": { "title": "On sale only", "type": "boolean", "description": "Keep only products priced below their list price.", "default": false }, "inStockOnly": { "title": "Available online only", "type": "boolean", "description": "Keep only products that can ship now (in stock online, or eBooks).", "default": false }, "emitEachFormat": { "title": "One row per format", "type": "boolean", "description": "Give every format of a book (hardcover, paperback, eBook, audiobook…) its own row with its own ISBN, price and stock. Off: one row per book, other formats listed inside it.", "default": false }, "includeStoreStock": { "title": "Per-store stock", "type": "boolean", "description": "Live stock at each Indigo, Chapters and Coles store: store name, city, postal code, phone, quantity on hand and pickup time. Also refreshes the online quantity.", "default": false }, "storeFilter": { "title": "Stores to list", "type": "array", "description": "Only list stores matching one of these: a city (Toronto), a province code (ON, BC), a postal code or its start (M5V, V6), or part of a store name (Yorkdale). Leave empty for every store.", "items": { "type": "string" } }, "storesInStockOnly": { "title": "Only stores that have it", "type": "boolean", "description": "List only stores with the item in stock. The in-stock store count is always included.", "default": true }, "includeReviews": { "title": "Ratings & reviews", "type": "boolean", "description": "Adds the review count, star breakdown, reader ratings (reading pace, resonance…) and the latest reviews.", "default": false }, "maxReviews": { "title": "Reviews per product", "minimum": 0, "maximum": 1000, "type": "integer", "description": "How many of the latest reviews to include per product. 0 = the rating breakdown only.", "default": 10 }, "includeDescription": { "title": "Include description", "type": "boolean", "description": "The publisher's description of each product.", "default": true }, "includeNotFound": { "title": "Rows for codes Indigo doesn't carry", "type": "boolean", "description": "Add a row with found: false for every ISBN, barcode or link that Indigo does not sell, so your list lines up one-to-one.", "default": false }, "followRedirects": { "title": "Follow category redirects", "type": "boolean", "description": "Broad words like \"romance\" or \"cookbooks\" take you to a curated collection on indigo.ca. On: scrape that collection, like the website. Off: plain keyword matches.", "default": true }, "maxConcurrency": { "title": "Max parallel requests", "minimum": 1, "maximum": 30, "type": "integer", "description": "Higher is faster for long ISBN lists and big crawls.", "default": 10 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Apify's datacenter proxy works and is the cheapest. The actor switches to residential proxies by itself if the store ever blocks datacenter traffic.", "default": { "useApifyProxy": true } } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }