{"openapi":"3.1.0","info":{"title":"AI Find Me directory API","version":"1.2.0","summary":"Search businesses and read their fact cards.","description":"Search the AI Find Me directory and read each business's fact card: services, prices, hours, location, FAQs and official links, read from the business's own website (and, where the website doesn't say, from OpenStreetMap, credited). Web shops carry what they run on and sell: categories, price range, a sample of products with prices and stock, shipping countries, delivery time, free-shipping threshold, return period, review profiles (kind=shop filters the search to shops; /api/v1/businesses/{slug}/products has the products). Free, no key, up to 600 requests a minute per address. Every listing is re-checked about every 7 days. Each fact says where it came from, and each listing says whether its owner has verified it. Facts from OpenStreetMap are © OpenStreetMap contributors (ODbL); keep the attribution when you republish them.","termsOfService":"https://aifindme.com/terms","contact":{"name":"Imfiy B.V.","url":"https://aifindme.com/contact","email":"info@imfiy.com"}},"externalDocs":{"description":"Documentation for AI agents and developers","url":"https://aifindme.com/for-ai-agents"},"servers":[{"url":"https://aifindme.com"}],"tags":[{"name":"businesses","description":"Search and fact cards"},{"name":"directory","description":"Categories and cities"}],"paths":{"/api/v1/businesses":{"get":{"operationId":"searchBusinesses","tags":["businesses"],"summary":"Search businesses","description":"Full-text search over names, categories, cities, summaries, addresses, services, prices and FAQs. Every word must match as a prefix (\"vegan caf\" finds \"vegan café\"); accents are ignored. Results favour owner-verified, complete and recently checked listings. Without q, lists businesses (verified and complete ones first). Answers are cacheable for a minute and carry an ETag; the limit is 600 requests a minute per address, 1,500 when the User-Agent carries a contact URL or email.","parameters":[{"name":"q","in":"query","schema":{"type":"string","maxLength":200},"description":"Words to search for: a service, product, business name, feature or city.","example":"vegan cafe"},{"name":"category","in":"query","schema":{"type":"string","enum":["restaurant","cafe","bakery","bar","hotel","dentist","health","beauty","fitness","legal","finance","realestate","home","auto","retail","software","agency","education","events","travel","pets","creative","nonprofit","other"]},"description":"Category key (see /api/v1/categories)."},{"name":"city","in":"query","schema":{"type":"string","maxLength":80},"description":"City name, as people write it (\"Amsterdam\").","example":"Amsterdam"},{"name":"kind","in":"query","schema":{"type":"string","enum":["shop"]},"description":"kind=shop: only web shops (online stores), e.g. for \"where can I buy X\" questions."},{"name":"country","in":"query","schema":{"type":"string","pattern":"^[A-Za-z]{2}$"},"description":"One country, as an ISO 3166 code: NL (Netherlands), BE (Belgium) or US (United States). Every result carries its country.","example":"US"},{"name":"verified","in":"query","schema":{"type":"string","enum":["1"]},"description":"verified=1: only listings whose owner proved control of the website and so vouches for the facts."},{"name":"open","in":"query","schema":{"type":"string","enum":["now"]},"description":"open=now: only businesses open at this moment, judged from their structured opening hours in their own time zone. Listings without such hours are left out, so an empty answer does not mean everything is closed."},{"name":"fields","in":"query","schema":{"type":"string"},"description":"Comma-separated fields to return for each result (slug always comes), e.g. fields=slug,name,phone,website. Unknown names are ignored.","example":"slug,name,phone"},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":50,"default":10}},{"name":"offset","in":"query","schema":{"type":"integer","minimum":0,"maximum":10000,"default":0},"description":"Results to skip (larger values count as 10000)"}],"responses":{"200":{"description":"Matching businesses","content":{"application/json":{"schema":{"type":"object","properties":{"total":{"type":"integer","description":"How many match in all"},"limit":{"type":"integer"},"offset":{"type":"integer"},"results":{"type":"array","items":{"type":"object","description":"A business as it appears in search results. The full fact card is one more request away (factCard, or GET /api/v1/businesses/{slug}).","properties":{"slug":{"type":"string","description":"The identifier used in every address of this business: /b/{slug}, /b/{slug}.md, /api/v1/businesses/{slug}."},"name":{"type":["string","null"],"description":"Business name"},"category":{"type":"string","description":"Category key (see GET /api/v1/categories)."},"city":{"type":["string","null"],"description":"City the business is in, as written on its website or in OpenStreetMap."},"country":{"type":["string","null"],"description":"Country the business is in, as an ISO 3166 code (NL, US), from the country its website states or its domain ending; null when unknown."},"summary":{"type":["string","null"],"description":"One-sentence summary, at most 300 characters."},"phone":{"type":["string","null"],"description":"Phone number as written on the website."},"website":{"type":"string","description":"The business’s own website."},"ownerVerified":{"type":"boolean","description":"True when the business owner has proved they control the website and so vouches for the facts."},"lastChecked":{"type":["string","null"],"description":"When the website was last read (ISO 8601)."},"factCard":{"type":"string","description":"Address of the full fact card as Markdown."},"shop":{"type":"object","description":"Only for web shops: platform, productCount, categories (up to 8) and the products address.","properties":{"platform":{"type":["string","null"]},"productCount":{"type":["integer","null"]},"categories":{"type":"array","items":{"type":"string"}},"products":{"type":"string"}}}}}}}},"example":{"total":1,"limit":10,"offset":0,"results":[{"slug":"example-cafe","name":"Example Café","category":"cafe","city":"Amsterdam","summary":"Specialty coffee and brunch on the canal.","phone":"+31 20 000 0000","website":"https://example-cafe.example/","ownerVerified":true,"lastChecked":"2026-11-15T09:00:00.000Z","factCard":"https://aifindme.com/b/example-cafe.md"}]}}}},"429":{"description":"Too many requests. Wait the number of seconds in Retry-After, then try again.","headers":{"Retry-After":{"description":"Seconds to wait","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}}}},"/api/v1/new":{"get":{"operationId":"listNewListings","tags":["businesses"],"summary":"List new listings since a date","description":"Businesses added to the directory since `since` (default: the last 7 days; at most 90 days back), newest first, each with its listing date. kind=shop keeps the web shops. Poll it (every hour is plenty; answers are cached for 5 minutes) to learn about new shops, then fetch their cards and products. The same list is an Atom feed at /feed/new.xml (?kind=shop) and a page at /new and /new/shops.","parameters":[{"name":"since","in":"query","schema":{"type":"string","format":"date-time"},"description":"ISO date or date-time, e.g. 2026-11-08 or 2026-11-08T00:00:00Z. Earlier than 90 days ago counts as 90 days ago.","example":"2026-11-08"},{"name":"kind","in":"query","schema":{"type":"string","enum":["shop"]},"description":"kind=shop: only web shops."},{"name":"country","in":"query","schema":{"type":"string","pattern":"^[A-Za-z]{2}$"},"description":"One country, as an ISO 3166 code: NL (Netherlands), BE (Belgium) or US (United States).","example":"US"},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100,"default":50}},{"name":"offset","in":"query","schema":{"type":"integer","minimum":0,"maximum":10000,"default":0}}],"responses":{"200":{"description":"New listings, newest first","content":{"application/json":{"schema":{"type":"object","properties":{"since":{"type":"string","description":"The date the list starts at, as used."},"kind":{"type":"string","enum":["all","shop"]},"country":{"type":["string","null"],"description":"The country asked for, when one was."},"total":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"results":{"type":"array","items":{"type":"object","description":"A business as it appears in search results. The full fact card is one more request away (factCard, or GET /api/v1/businesses/{slug}).","properties":{"slug":{"type":"string","description":"The identifier used in every address of this business: /b/{slug}, /b/{slug}.md, /api/v1/businesses/{slug}."},"name":{"type":["string","null"],"description":"Business name"},"category":{"type":"string","description":"Category key (see GET /api/v1/categories)."},"city":{"type":["string","null"],"description":"City the business is in, as written on its website or in OpenStreetMap."},"country":{"type":["string","null"],"description":"Country the business is in, as an ISO 3166 code (NL, US), from the country its website states or its domain ending; null when unknown."},"summary":{"type":["string","null"],"description":"One-sentence summary, at most 300 characters."},"phone":{"type":["string","null"],"description":"Phone number as written on the website."},"website":{"type":"string","description":"The business’s own website."},"ownerVerified":{"type":"boolean","description":"True when the business owner has proved they control the website and so vouches for the facts."},"lastChecked":{"type":["string","null"],"description":"When the website was last read (ISO 8601)."},"factCard":{"type":"string","description":"Address of the full fact card as Markdown."},"shop":{"type":"object","description":"Only for web shops: platform, productCount, categories (up to 8) and the products address.","properties":{"platform":{"type":["string","null"]},"productCount":{"type":["integer","null"]},"categories":{"type":"array","items":{"type":"string"}},"products":{"type":"string"}}},"listedSince":{"type":"string","description":"When the listing was created (ISO 8601)."}}}}}}}}},"400":{"description":"since is not a date","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}},"429":{"description":"Too many requests. Wait the number of seconds in Retry-After, then try again.","headers":{"Retry-After":{"description":"Seconds to wait","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}}}},"/api/v1/businesses/{slug}":{"get":{"operationId":"getBusiness","tags":["businesses"],"summary":"Get one business fact card","description":"Every fact the directory holds about one business, with the source of each fact and the credits that go with it. The same data is available as Markdown at /b/{slug}.md.","parameters":[{"name":"slug","in":"path","required":true,"schema":{"type":"string","pattern":"^[a-z0-9-]{1,100}$"},"description":"From search results, or the last part of a /b/… address."}],"responses":{"200":{"description":"The full fact card","content":{"application/json":{"schema":{"type":"object","description":"Every fact the directory holds about one business, with where each fact came from. Fields are null or empty when the website did not say.","properties":{"name":{"type":["string","null"],"description":"Business name"},"category":{"type":"object","properties":{"key":{"type":"string"},"label":{"type":"string"}}},"summary":{"type":["string","null"],"description":"One-sentence summary (at most 300 characters)."},"about":{"type":["string","null"],"description":"Longer description, up to 1,500 characters."},"website":{"type":"string"},"contact":{"type":"object","properties":{"phone":{"type":["string","null"],"description":"Phone number"},"email":{"type":["string","null"],"description":"Public email address"},"contactPage":{"type":["string","null"],"description":"Contact page on the website"}}},"location":{"type":"object","properties":{"address":{"type":["string","null"],"description":"Full address as written"},"city":{"type":["string","null"],"description":"City"},"region":{"type":["string","null"],"description":"Region or state"},"postalCode":{"type":["string","null"],"description":"Postal code"},"country":{"type":["string","null"],"description":"Country"},"geo":{"type":["object","null"],"properties":{"lat":{"type":"number"},"lng":{"type":"number"}}},"areaServed":{"type":"array","description":"Places the business serves, for businesses that travel to customers.","items":{"type":"string"}},"mapUrl":{"type":["string","null"],"description":"A map link for the address or coordinates."},"timeZone":{"type":["string","null"],"description":"IANA time zone of the business, when it can be told from the country or postal code (use it to read the opening hours)."}}},"hours":{"type":"array","description":"Opening hours as lines people read, e.g. \"Mon–Fri: 09:00–17:00\".","items":{"type":"string"}},"openingHoursSpecification":{"type":"array","description":"Structured opening hours.","items":{"type":"object","properties":{"days":{"type":"array","items":{"type":"string","enum":["Mon","Tue","Wed","Thu","Fri","Sat","Sun"]}},"opens":{"type":"string","description":"HH:MM"},"closes":{"type":"string","description":"HH:MM; at or before \"opens\" means after midnight."}}}},"priceRange":{"type":["string","null"],"description":"Price range as written, e.g. \"€€\" or \"$10–$30\"."},"cuisine":{"type":["string","null"],"description":"Cuisine (restaurants, cafés, bars)."},"services":{"type":"array","description":"Services or products offered.","items":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":["string","null"],"description":"Short description"},"price":{"type":["string","null"],"description":"Price, when the website gives one"}}}},"priceList":{"type":"array","description":"Prices as written on the website.","items":{"type":"object","properties":{"name":{"type":"string"},"price":{"type":"string"}}}},"faqs":{"type":"array","description":"Questions and answers from the website.","items":{"type":"object","properties":{"question":{"type":"string"},"answer":{"type":"string"}}}},"rating":{"type":["object","null"],"description":"A rating the business shows on its own website (not the directory’s opinion).","properties":{"value":{"type":"number"},"best":{"type":"number"},"count":{"type":["integer","null"]}}},"features":{"type":"array","description":"Amenities and options, e.g. \"Wheelchair accessible\", \"Delivery\", \"Takeaway\", \"Vegan options\", \"Reservations recommended\".","items":{"type":"string"}},"paymentMethods":{"type":"array","items":{"type":"string"}},"languages":{"type":"array","description":"Languages the website is offered in or says are spoken.","items":{"type":"string"}},"foundingYear":{"type":["string","null"],"description":"Year founded"},"registration":{"type":"object","properties":{"companyNumber":{"type":["string","null"],"description":"Company registration number (e.g. Chamber of Commerce / KvK)"},"vatNumber":{"type":["string","null"],"description":"VAT number"}}},"shop":{"type":["object","null"],"description":"Present for web shops (online stores): what the shop runs on and sells, and the facts an assistant needs to recommend it. null for other businesses.","properties":{"platform":{"type":["string","null"],"description":"Shop platform: Shopify, WooCommerce, Lightspeed, Shopware, Magento, BigCommerce, PrestaShop, CCV Shop, Mijnwebwinkel, Wix Stores, Squarespace Commerce…"},"status":{"type":"string","enum":["open","locked","empty"],"description":"open: selling; locked: behind a password / \"opening soon\" page; empty: no products listed."},"currency":{"type":["string","null"],"description":"The shop’s currency (ISO 4217)."},"categories":{"type":"array","description":"What the shop sells: its own collections, categories or product types.","items":{"type":"string"}},"priceRange":{"type":["object","null"],"properties":{"min":{"type":"number"},"max":{"type":"number"},"currency":{"type":["string","null"]},"text":{"type":["string","null"],"description":"e.g. \"€4.95–€89\""},"sampled":{"type":["integer","null"],"description":"How many products the range was read from."}}},"productCount":{"type":["integer","null"],"description":"How many products the shop publishes (from its platform data or product sitemap)."},"productsUpdatedAt":{"type":["string","null"],"description":"When the shop itself last changed a product, when its platform says (ISO 8601)."},"productsSyncedAt":{"type":["string","null"],"description":"When the directory last read the shop’s products."},"productsChangedAt":{"type":["string","null"],"description":"When the directory last saw the product sample change (names, prices or stock)."},"shipping":{"type":"object","properties":{"countries":{"type":"array","description":"Countries the shop says it ships to.","items":{"type":"string"}},"deliveryTime":{"type":["string","null"],"description":"As the shop states it, e.g. \"1-3 working days\" or \"Voor 23:00 besteld, morgen in huis\"."},"freeShippingFrom":{"type":["string","null"],"description":"Free-shipping threshold, e.g. \"€50\"."},"page":{"type":["string","null"],"description":"The shop’s shipping information page."}}},"returns":{"type":"object","properties":{"period":{"type":["string","null"],"description":"Return period, e.g. \"30 days\"."},"page":{"type":["string","null"],"description":"The shop’s returns page."}}},"reviews":{"type":"array","description":"The shop’s profiles on review platforms (Trustpilot, Kiyoh, WebwinkelKeur, Google…).","items":{"type":"object","properties":{"platform":{"type":"string"},"url":{"type":"string"}}}},"trustMarks":{"type":"array","description":"Trust marks the shop shows (Thuiswinkel Waarborg, WebwinkelKeur, Trusted Shops…).","items":{"type":"string"}},"products":{"type":"array","description":"A sample of the shop’s products (up to 12 for unclaimed shops, more for claimed ones).","items":{"type":"object","description":"One product, as the shop publishes it (Shopify products.json, the WooCommerce Store API, or schema.org Product data on the shop’s pages).","properties":{"name":{"type":"string"},"url":{"type":["string","null"],"description":"The product page on the shop’s website."},"image":{"type":["string","null"],"description":"Product image."},"price":{"type":["number","null"],"description":"Lowest price, in `currency`."},"priceMax":{"type":["number","null"],"description":"Highest variant price, when variants differ."},"currency":{"type":["string","null"],"description":"ISO 4217 code, e.g. EUR."},"priceText":{"type":["string","null"],"description":"The price as people write it, e.g. \"€12.95\" or \"€12.95–€19.95\"."},"availability":{"type":["string","null"],"description":"\"in stock\", \"out of stock\", \"preorder\", \"backorder\", or null when the shop does not say."},"category":{"type":["string","null"],"description":"The shop’s own category or product type."},"brand":{"type":["string","null"],"description":"Brand or vendor."},"description":{"type":["string","null"],"description":"Short description, at most 240 characters."},"updatedAt":{"type":["string","null"],"description":"When the shop last changed this product, when the platform says (ISO 8601)."}}}},"productsUrl":{"type":"string","description":"GET /api/v1/businesses/{slug}/products: the products with the shop facts around them."}}},"links":{"type":"object","properties":{"booking":{"type":["string","null"],"description":"Booking or reservation link"},"order":{"type":["string","null"],"description":"Online ordering link"},"menu":{"type":["string","null"],"description":"Menu"},"pricing":{"type":["string","null"],"description":"Pricing page"},"socials":{"type":"array","items":{"type":"object","properties":{"network":{"type":"string"},"url":{"type":"string"}}}}}},"images":{"type":"object","properties":{"logo":{"type":["string","null"]},"image":{"type":["string","null"]}}},"directory":{"type":"object","description":"About the listing itself.","properties":{"url":{"type":"string"},"markdown":{"type":"string"},"json":{"type":"string"},"llmsTxt":{"type":"string"},"ownerVerified":{"type":"boolean"},"claimed":{"type":"boolean","description":"Someone has added or claimed the listing in their account (not necessarily verified)."},"verification":{"type":"string","enum":["owner-verified","claimed","unclaimed"]},"lastChecked":{"type":["string","null"],"description":"When the website was last read."},"lastChanged":{"type":["string","null"],"description":"When the published facts last changed."},"listedSince":{"type":["string","null"],"description":"When the listing was created."},"recheckedEveryDays":{"type":"integer","description":"Every listing is read again about this often."},"status":{"type":"string","enum":["active","inactive"],"description":"inactive: kept, but out of the directory pages, search results and sitemaps until a check finds the website alive again (unreachable for several checks, a shop behind a password page or without products, a parked domain, no product change for a year)."},"inactive":{"type":["object","null"],"properties":{"since":{"type":["string","null"]},"reason":{"type":"string","enum":["unreachable","locked","empty","parked","coming-soon","stale"]},"text":{"type":"string"}}},"completeness":{"type":"object","properties":{"have":{"type":"integer"},"of":{"type":"integer"},"missing":{"type":"array","description":"Key facts the website did not give.","items":{"type":"string"}}}},"sources":{"type":"object","description":"The source of each published fact, by field name.","additionalProperties":{"type":"object","description":"Where a fact came from.","properties":{"source":{"type":"string","description":"One of: \"structured data\" (schema.org on the website), \"page metadata\", \"page text\", \"shop platform data\" (the shop’s own product data), \"website signals\" (the country, judged from the shop’s market, currency, phone numbers and addresses when the website states none), \"AI model\", \"OpenStreetMap\", \"business owner\" (confirmed or corrected by the verified owner)."},"url":{"type":["string","null"],"description":"The page the fact was read from, or the OpenStreetMap object."}}}},"attributions":{"type":"array","description":"Credits that must accompany the facts (OpenStreetMap, ODbL).","items":{"type":"object","properties":{"source":{"type":"string"},"text":{"type":"string"},"licence":{"type":"string"},"licenceUrl":{"type":"string"},"url":{"type":"string"}}}}}}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}},"410":{"description":"This listing was removed from the directory (an inactive listing still answers, with directory.status \"inactive\")","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}},"429":{"description":"Too many requests. Wait the number of seconds in Retry-After, then try again.","headers":{"Retry-After":{"description":"Seconds to wait","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}}}},"/api/v1/businesses/{slug}/products":{"get":{"operationId":"getProducts","tags":["businesses"],"summary":"Get a web shop’s products","description":"The shop facts (platform, categories, price range, shipping, returns, reviews) and a sample of the shop’s products with name, price, stock, link and image, as the shop publishes them and as read at the listing’s last check. For a listing that is not a web shop, shop is null and products is empty. /api/v1/b/{slug}/products is the same address.","parameters":[{"name":"slug","in":"path","required":true,"schema":{"type":"string","pattern":"^[a-z0-9-]{1,100}$"}},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":250},"description":"Products to return (default: all the directory holds for this shop)."}],"responses":{"200":{"description":"The shop’s products","content":{"application/json":{"schema":{"type":"object","properties":{"slug":{"type":"string"},"name":{"type":["string","null"]},"website":{"type":"string"},"shop":{"type":["object","null"],"description":"Present for web shops (online stores): what the shop runs on and sells, and the facts an assistant needs to recommend it. null for other businesses.","properties":{"platform":{"type":["string","null"],"description":"Shop platform: Shopify, WooCommerce, Lightspeed, Shopware, Magento, BigCommerce, PrestaShop, CCV Shop, Mijnwebwinkel, Wix Stores, Squarespace Commerce…"},"status":{"type":"string","enum":["open","locked","empty"],"description":"open: selling; locked: behind a password / \"opening soon\" page; empty: no products listed."},"currency":{"type":["string","null"],"description":"The shop’s currency (ISO 4217)."},"categories":{"type":"array","description":"What the shop sells: its own collections, categories or product types.","items":{"type":"string"}},"priceRange":{"type":["object","null"],"properties":{"min":{"type":"number"},"max":{"type":"number"},"currency":{"type":["string","null"]},"text":{"type":["string","null"],"description":"e.g. \"€4.95–€89\""},"sampled":{"type":["integer","null"],"description":"How many products the range was read from."}}},"productCount":{"type":["integer","null"],"description":"How many products the shop publishes (from its platform data or product sitemap)."},"productsUpdatedAt":{"type":["string","null"],"description":"When the shop itself last changed a product, when its platform says (ISO 8601)."},"productsSyncedAt":{"type":["string","null"],"description":"When the directory last read the shop’s products."},"productsChangedAt":{"type":["string","null"],"description":"When the directory last saw the product sample change (names, prices or stock)."},"shipping":{"type":"object","properties":{"countries":{"type":"array","description":"Countries the shop says it ships to.","items":{"type":"string"}},"deliveryTime":{"type":["string","null"],"description":"As the shop states it, e.g. \"1-3 working days\" or \"Voor 23:00 besteld, morgen in huis\"."},"freeShippingFrom":{"type":["string","null"],"description":"Free-shipping threshold, e.g. \"€50\"."},"page":{"type":["string","null"],"description":"The shop’s shipping information page."}}},"returns":{"type":"object","properties":{"period":{"type":["string","null"],"description":"Return period, e.g. \"30 days\"."},"page":{"type":["string","null"],"description":"The shop’s returns page."}}},"reviews":{"type":"array","description":"The shop’s profiles on review platforms (Trustpilot, Kiyoh, WebwinkelKeur, Google…).","items":{"type":"object","properties":{"platform":{"type":"string"},"url":{"type":"string"}}}},"trustMarks":{"type":"array","description":"Trust marks the shop shows (Thuiswinkel Waarborg, WebwinkelKeur, Trusted Shops…).","items":{"type":"string"}},"productsUrl":{"type":"string","description":"GET /api/v1/businesses/{slug}/products: the products with the shop facts around them."}}},"total":{"type":["integer","null"],"description":"How many products the shop publishes in all."},"count":{"type":"integer","description":"How many are in this answer."},"products":{"type":"array","items":{"type":"object","description":"One product, as the shop publishes it (Shopify products.json, the WooCommerce Store API, or schema.org Product data on the shop’s pages).","properties":{"name":{"type":"string"},"url":{"type":["string","null"],"description":"The product page on the shop’s website."},"image":{"type":["string","null"],"description":"Product image."},"price":{"type":["number","null"],"description":"Lowest price, in `currency`."},"priceMax":{"type":["number","null"],"description":"Highest variant price, when variants differ."},"currency":{"type":["string","null"],"description":"ISO 4217 code, e.g. EUR."},"priceText":{"type":["string","null"],"description":"The price as people write it, e.g. \"€12.95\" or \"€12.95–€19.95\"."},"availability":{"type":["string","null"],"description":"\"in stock\", \"out of stock\", \"preorder\", \"backorder\", or null when the shop does not say."},"category":{"type":["string","null"],"description":"The shop’s own category or product type."},"brand":{"type":["string","null"],"description":"Brand or vendor."},"description":{"type":["string","null"],"description":"Short description, at most 240 characters."},"updatedAt":{"type":["string","null"],"description":"When the shop last changed this product, when the platform says (ISO 8601)."}}}},"note":{"type":"string"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}},"410":{"description":"This listing was removed from the directory","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}},"429":{"description":"Too many requests. Wait the number of seconds in Retry-After, then try again.","headers":{"Retry-After":{"description":"Seconds to wait","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}}}},"/api/v1/categories":{"get":{"operationId":"listCategories","tags":["directory"],"summary":"List categories with counts","description":"Every category the directory uses, with its key (for the category parameter), label and number of active listings.","responses":{"200":{"description":"Categories","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"label":{"type":"string"},"businesses":{"type":"integer","description":"Active listings in this category"}}}}}}},"429":{"description":"Too many requests. Wait the number of seconds in Retry-After, then try again.","headers":{"Retry-After":{"description":"Seconds to wait","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}}}},"/api/v1/cities":{"get":{"operationId":"listCities","tags":["directory"],"summary":"List cities with counts","description":"The cities with listings, most listings first, with the value to pass as the city parameter.","parameters":[{"name":"category","in":"query","schema":{"type":"string","enum":["restaurant","cafe","bakery","bar","hotel","dentist","health","beauty","fitness","legal","finance","realestate","home","auto","retail","software","agency","education","events","travel","pets","creative","nonprofit","other"]},"description":"Only cities with listings in this category."}],"responses":{"200":{"description":"Cities","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"label":{"type":"string"},"businesses":{"type":"integer","description":"Active listings in this city"}}}}}}},"429":{"description":"Too many requests. Wait the number of seconds in Retry-After, then try again.","headers":{"Retry-After":{"description":"Seconds to wait","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}}}}}}