{"openapi":"3.1.0","info":{"title":"Etsy API (Bowmark)","version":"e833508f87ff","description":"Etsy's own documented Open API v3 (openapi.etsy.com) — searches active listings on etsy.com by keyword and returns id, title, price, currency, quantity, tags and the listing's own etsy.com URL, without scraping etsy.com's search page (which sits behind DataDome).\n\nEvery function Bowmark has for Etsy (etsy.com) as one HTTP call. Each runs on Bowmark's infrastructure with the same billing, rules and response envelope as `POST /v1/run`. The whole API: https://api.bowmark.ai/openapi.json. Guide: https://bowmark.ai/docs/api.","contact":{"email":"support@bowmark.ai","url":"https://bowmark.ai/docs/api"}},"servers":[{"url":"https://api.bowmark.ai"}],"security":[{"bearer":[]},{"apiKeyHeader":[]}],"paths":{"/v1/sites/etsy/search":{"post":{"operationId":"search","summary":"Searches Etsy's live catalog of active listings by keyword and returns the matching listings — id, title, price, currency, quantity available, tags and the listing's own etsy.com URL.","description":"Searches Etsy's live catalog of active listings by keyword and returns the matching listings — id, title, price, currency, quantity available, tags and the listing's own etsy.com URL. `limit` caps the row count (default 10, Etsy's own ceiling 100 when a key is held). Takes a key optionally: with one (yours, on `x-bowmark-vendor-key-etsy`) it calls Etsy's documented Open API v3; with none it reads www.etsy.com's own search page instead, which carries a quantity of `null` and no tags.\n\nCalls `bowmark.providers.etsy.search`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<etsyListing[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"anyOf":[{"type":"string"},{"type":"object","properties":{"query":{"type":"string"},"limit":{"type":"number"}},"required":["query"],"additionalProperties":true}],"description":"TypeScript: `string | { query: string; limit?: number }`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/etsy/getListing":{"post":{"operationId":"getListing","summary":"One Etsy listing by its id or etsy.com/listing URL — title, description, price, currency, how many are in stock, whether shipping is free, the shop's star rating and review count, its photos, the shop","description":"One Etsy listing by its id or etsy.com/listing URL — title, description, price, currency, how many are in stock, whether shipping is free, the shop's star rating and review count, its photos, the shop name, Etsy's own category breadcrumb and the listing's own URL.\n\nCalls `bowmark.providers.etsy.getListing`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<EtsyListingDetail>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"idOrUrl":{"anyOf":[{"type":"number"},{"type":"string"}],"description":"TypeScript: `number | string`"}},"required":["idOrUrl"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/etsy/listListingReviews":{"post":{"operationId":"listListingReviews","summary":"The reviews on one Etsy listing — reviewer name, star rating out of the site's own scale, the date and the review text.","description":"The reviews on one Etsy listing — reviewer name, star rating out of the site's own scale, the date and the review text. Takes the same id or URL as `getListing`.\n\nCalls `bowmark.providers.etsy.listListingReviews`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<EtsyListingReview[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"idOrUrl":{"anyOf":[{"type":"number"},{"type":"string"}],"description":"TypeScript: `number | string`"}},"required":["idOrUrl"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/etsy/getShop":{"post":{"operationId":"getShop","summary":"One Etsy shop by its name or etsy.com/shop URL — tagline, location, logo, star rating and review count, total sales, admirers and the year it opened on Etsy.","description":"One Etsy shop by its name or etsy.com/shop URL — tagline, location, logo, star rating and review count, total sales, admirers and the year it opened on Etsy.\n\nCalls `bowmark.providers.etsy.getShop`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<EtsyShop>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"nameOrUrl":{"type":"string","description":"TypeScript: `string`"}},"required":["nameOrUrl"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/etsy/listShopListings":{"post":{"operationId":"listShopListings","summary":"The items on one page of an Etsy shop (`page` from 1, default 1, about 35 per page) — listing id, title, price, currency and URL (quantity and tags are `null`/empty, as on the keyless search door).","description":"The items on one page of an Etsy shop (`page` from 1, default 1, about 35 per page) — listing id, title, price, currency and URL (quantity and tags are `null`/empty, as on the keyless search door). Takes the same name or URL as `getShop`.\n\nCalls `bowmark.providers.etsy.listShopListings`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<etsyListing[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"nameOrUrl":{"anyOf":[{"type":"string"},{"type":"object","properties":{"shop":{"type":"string"},"page":{"type":"number"}},"required":["shop"],"additionalProperties":true}],"description":"TypeScript: `string | { shop: string; page?: number }`"}},"required":["nameOrUrl"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/etsy/listShopReviews":{"post":{"operationId":"listShopReviews","summary":"One page of the reviews an Etsy shop has received across all its listings, newest first — reviewer, date, stars, review text, the seller's reply and which listing it was for — plus whether a next page","description":"One page of the reviews an Etsy shop has received across all its listings, newest first — reviewer, date, stars, review text, the seller's reply and which listing it was for — plus whether a next page exists. Takes the same name or URL as `getShop`; pass `{ shop, page }` for later pages.\n\nCalls `bowmark.providers.etsy.listShopReviews`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<EtsyShopReviewPage>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"nameOrUrl":{"anyOf":[{"type":"string"},{"type":"object","properties":{"shop":{"type":"string"},"page":{"type":"number"}},"required":["shop"],"additionalProperties":true}],"description":"TypeScript: `string | { shop: string; page?: number }`"}},"required":["nameOrUrl"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/etsy/searchShops":{"post":{"operationId":"searchShops","summary":"Etsy shops whose name contains a word — each shop's name, tagline, item count and URL.","description":"Etsy shops whose name contains a word — each shop's name, tagline, item count and URL. The door from a half-remembered shop name to `getShop`.\n\nCalls `bowmark.providers.etsy.searchShops`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<EtsyShopSearchRow[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"query":{"type":"string","description":"TypeScript: `string`"}},"required":["query"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/etsy/getUserProfile":{"post":{"operationId":"getUserProfile","summary":"A member's public Etsy profile by username or etsy.com/people URL — display name, their public favorites collections (name, item count, URL) and the shops they follow (name, avatar, star rating, revie","description":"A member's public Etsy profile by username or etsy.com/people URL — display name, their public favorites collections (name, item count, URL) and the shops they follow (name, avatar, star rating, review count, URL).\n\nCalls `bowmark.providers.etsy.getUserProfile`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<EtsyUserProfile>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"usernameOrUrl":{"type":"string","description":"TypeScript: `string`"}},"required":["usernameOrUrl"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/etsy/listEditorsPicks":{"post":{"operationId":"listEditorsPicks","summary":"Etsy's Editors' Picks.","description":"Etsy's Editors' Picks. With no argument, the curated collections on /featured (slug, title, blurb, image, URL); with a collection slug or URL, that collection's title, subtitle and listings (id, title, price, original price, rating, review count, image, URL).\n\nCalls `bowmark.providers.etsy.listEditorsPicks`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<EtsyEditorsPicks>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"collection":{"type":"string","description":"TypeScript: `string`"}},"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/etsy/findRegistry":{"post":{"operationId":"findRegistry","summary":"Finds Etsy gift registries (wedding, baby, gift) by the registrant's first and last name — each match's registry id, name, city, event month and URL.","description":"Finds Etsy gift registries (wedding, baby, gift) by the registrant's first and last name — each match's registry id, name, city, event month and URL. The door for `getRegistry`.\n\nCalls `bowmark.providers.etsy.findRegistry`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<EtsyRegistryMatch[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"object","properties":{"firstName":{"type":"string"},"lastName":{"type":"string"}},"required":["firstName","lastName"],"additionalProperties":true}],"description":"TypeScript: `string | { firstName: string; lastName: string }`"}},"required":["name"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/etsy/getRegistry":{"post":{"operationId":"getRegistry","summary":"One Etsy gift registry by the id `findRegistry` returns or its URL — name, event type and date, city, items requested and purchased, and each item on first load (listing id, title, shop, price, image,","description":"One Etsy gift registry by the id `findRegistry` returns or its URL — name, event type and date, city, items requested and purchased, and each item on first load (listing id, title, shop, price, image, quantity requested, purchased and still needed, URL).\n\nCalls `bowmark.providers.etsy.getRegistry`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<EtsyRegistry>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"registryIdOrUrl":{"type":"string","description":"TypeScript: `string`"}},"required":["registryIdOrUrl"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/etsy/listCategories":{"post":{"operationId":"listCategories","summary":"Etsy's category tree from its own /categories page — each top-level department (Accessories, Home & Living, …) with its subcategories, every one carrying its name, its `/c/` path and URL.","description":"Etsy's category tree from its own /categories page — each top-level department (Accessories, Home & Living, …) with its subcategories, every one carrying its name, its `/c/` path and URL. The `path` is what `browseCategory` takes.\n\nCalls `bowmark.providers.etsy.listCategories`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<EtsyCategory[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/etsy/browseCategory":{"post":{"operationId":"browseCategory","summary":"One page of the listings in an Etsy category (a `listCategories` path like `jewelry/necklaces`, or its etsy.com/c/ URL) — each listing's id, title, price, currency and URL, the category's name, and th","description":"One page of the listings in an Etsy category (a `listCategories` path like `jewelry/necklaces`, or its etsy.com/c/ URL) — each listing's id, title, price, currency and URL, the category's name, and the narrower subcategories it links to. Filter by price in the site's currency, sort by relevance, price or newest, and page through.\n\nCalls `bowmark.providers.etsy.browseCategory`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<EtsyCategoryPage>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"path":{"anyOf":[{"type":"string"},{"type":"object","properties":{"path":{"type":"string"},"minPrice":{"type":"number"},"maxPrice":{"type":"number"},"sort":{"anyOf":[{"const":"most_relevant"},{"const":"price_asc"},{"const":"price_desc"},{"const":"date_desc"}]},"page":{"type":"number"}},"required":["path"],"additionalProperties":true}],"description":"TypeScript: `string | { path: string; minPrice?: number; maxPrice?: number; sort?: \"most_relevant\" | \"price_asc\" | \"price_desc\" | \"date_desc\"; page?: number }`"}},"required":["path"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/etsy/suggestSearches":{"post":{"operationId":"suggestSearches","summary":"What Etsy's search box suggests for text a person has typed so far — each suggested search with its etsy.com/search URL, plus the 'find shop names containing …' row (`kind: \"shop\"`, URL to the shop se","description":"What Etsy's search box suggests for text a person has typed so far — each suggested search with its etsy.com/search URL, plus the 'find shop names containing …' row (`kind: \"shop\"`, URL to the shop search).\n\nCalls `bowmark.providers.etsy.suggestSearches`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<EtsySearchSuggestion[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"text":{"type":"string","description":"TypeScript: `string`"}},"required":["text"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/etsy/listTrendingSearches":{"post":{"operationId":"listTrendingSearches","summary":"What people are searching for on Etsy right now — the 'Popular right now' list its empty search box shows, each with its search URL and thumbnail.","description":"What people are searching for on Etsy right now — the 'Popular right now' list its empty search box shows, each with its search URL and thumbnail.\n\nCalls `bowmark.providers.etsy.listTrendingSearches`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<EtsyTrendingSearch[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/etsy/estimateShipping":{"post":{"operationId":"estimateShipping","summary":"What one Etsy listing costs to ship and when it would arrive at a destination — a US ZIP, or a country the listing ships to (its own name, e.g.","description":"What one Etsy listing costs to ship and when it would arrive at a destination — a US ZIP, or a country the listing ships to (its own name, e.g. \"Canada\") with an optional postal code. Returns Etsy's delivery window (\"Nov 7-12\"), the cost (0 when free), the cost line as Etsy wrote it, the destination it used and where the item ships from.\n\nCalls `bowmark.providers.etsy.estimateShipping`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<EtsyShippingEstimate>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"type":"object","properties":{"listing":{"anyOf":[{"type":"number"},{"type":"string"}]},"zip":{"type":"string"},"country":{"type":"string"}},"required":["listing"],"additionalProperties":true,"description":"TypeScript: `{ listing: number | string; zip?: string; country?: string }`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}}},"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Your Bowmark API key."},"apiKeyHeader":{"type":"apiKey","in":"header","name":"X-Bowmark-Key"}},"responses":{"NotFound":{"description":"No such site or function.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}},"schemas":{"RunEnvelope":{"type":"object","description":"What a run returns. `status` says whether the SCRIPT succeeded. A script that threw or paused for a login is still HTTP 200. Branch on `status`, not on the HTTP code.","required":["ok","status","result","logs","error","ms"],"properties":{"runId":{"type":"string","description":"Stable id for this run. Quote it in a support or `report` message."},"ok":{"type":"boolean","description":"False only when the run produced nothing usable."},"status":{"type":"string","enum":["ok","error","partial","needs_user"],"description":"`partial`: the result is real but some calls failed (see `incomplete`); `ok` stays true. `needs_user`: a person must sign in to a site first. Relay `meta.handoff.url` to them, then run again."},"egress":{"type":"string","enum":["default","link"],"description":"The egress the run was given, present only when the request asked for one. `link`: every request went through the caller's own Chrome (Bowmark Buddy)."},"result":{"description":"Whatever the script `return`ed. Any JSON value."},"logs":{"type":"array","items":{"type":"string"},"description":"Lines the script wrote with `log(...)`."},"error":{"type":["string","null"],"description":"Why the run failed, in plain words. Null on success."},"ms":{"type":"integer","description":"How long the script itself ran, in milliseconds."},"queuedMs":{"type":"integer","description":"How long the run waited for a worker before starting. Present only when it was a second or more."},"needs":{"type":"array","description":"The sign-ins this script is waiting on. Present when `status` is `needs_user`.","items":{"type":"object","required":["capability","provider","providerTitle","kind"],"properties":{"capability":{"type":"string"},"provider":{"type":"string"},"providerTitle":{"type":"string","description":"The site's name, to show a person."},"kind":{"type":"string"}}}},"incomplete":{"type":"object","description":"Present only when `status` is `partial`: which calls did not answer.","properties":{"summary":{"type":"string"},"totalCalls":{"type":"integer"}},"additionalProperties":true},"emptyHanded":{"type":"object","description":"Present when the script returned nothing while its calls returned rows, usually a filter that matched none of the site's own labels. Lists the label values the calls actually returned.","additionalProperties":true},"notes":{"type":"array","description":"Caveats a call attached to a complete answer. Never changes `status`.","items":{"type":"object","properties":{"path":{"type":"string"},"notes":{"type":"array","items":{"type":"string"}}}}},"meta":{"type":"object","properties":{"handoff":{"type":"object","description":"A single-use sign-in link for a person to open. Expires at `expiresAt`.","properties":{"ref":{"type":"string"},"url":{"type":"string","format":"uri"},"expiresAt":{"type":"string","format":"date-time"}}},"concurrency":{"type":"object","description":"On a 429: how many runs are in flight and when to retry.","properties":{"limit":{"type":"integer"},"inFlight":{"type":"integer"},"retryAfterSeconds":{"type":"integer"}}}},"additionalProperties":true},"notice":{"type":"object","description":"Set when the account owner has not accepted the current Terms. Relay it to them.","additionalProperties":true}}}}}}