{ "openapi": "3.0.0", "components": { "examples": {}, "headers": {}, "parameters": {}, "requestBodies": {}, "responses": {}, "schemas": { "ApiSuccessResponse": { "properties": { "statusCode": { "type": "number", "format": "double", "description": "HTTP status code" }, "messageCode": { "type": "string", "description": "Status message code" }, "data": { "description": "Response data" } }, "required": [ "statusCode", "messageCode", "data" ], "type": "object", "additionalProperties": false }, "ApiErrorResponse": { "properties": { "statusCode": { "type": "number", "format": "double", "description": "HTTP status code" }, "messageCode": { "type": "string", "description": "Status message code" }, "message": { "type": "string", "description": "Error message" } }, "required": [ "statusCode", "messageCode", "message" ], "type": "object", "additionalProperties": false }, "BusinessDetailsRequest": { "description": "Request body for fetching business details by URL", "properties": { "url": { "type": "string", "description": "Full URL of the business on Yell website", "example": "https://www.yell.com/biz/apex-home-improvements-st-neots-901770225/" } }, "required": [ "url" ], "type": "object", "additionalProperties": false }, "BusinessListRequest": { "description": "Request body for fetching business list by URL", "properties": { "url": { "type": "string", "description": "Full URL of the business list on Yell website", "example": "https://www.yell.com/ucs/UcsSearchAction.do?keywords=carpenters+and+joiners&location=lancaster&scrambleSeed=1341422965" } }, "required": [ "url" ], "type": "object", "additionalProperties": false }, "SearchBusinessQuery": { "description": "Query parameters for searching businesses", "properties": { "keyword": { "type": "string", "description": "Search term to find bussiness on yell.com (only for filter-based scraping)", "example": "Butchers" }, "location": { "type": "string", "description": "The location find bussiness (e.g., Country, City, Town or Postcode)", "example": "united kingdom" }, "page": { "type": "integer", "format": "int32", "description": "Page number for pagination (starts from 1)", "example": 1, "minimum": 1 } }, "required": [ "keyword" ], "type": "object", "additionalProperties": false } }, "securitySchemes": {} }, "info": { "title": "Yell API", "version": "1.0.0" }, "paths": { "/scrapers/api/yell/business/get-by-url": { "post": { "operationId": "Get Business Details By Url", "responses": { "200": { "description": "Successfully retrieved business details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiSuccessResponse" }, "examples": { "Example 1": { "value": { "statusCode": 200, "messageCode": "OK", "data": [ { "id": "https://www.yell.com/biz/apex-home-improvements-st-neots-901770225/", "url": "https://www.yell.com/biz/apex-home-improvements-st-neots-901770225/", "name": "Yell", "tagline": "We are a local business providing great results.", "review": [ { "star": 5, "total_reviews": 7 }, { "star": 4, "total_reviews": 0 }, { "star": 3, "total_reviews": 0 }, { "star": 2, "total_reviews": 0 }, { "star": 1, "total_reviews": 0 } ], "rating": { "score": 5, "total_ratings": 7 }, "address": null, "geo": null, "telephone": "01480 270004", "website": "https://www.facebook.com/profile.php?id=61563565050327", "logo": "https://c.yell.com/t_bigRect,f_auto/4f5e17f6-684c-4fa7-ac54-e27c0fcabc56_image_png.png", "open_hours": null, "breadcrumbs": [ "Home", "Decking", "St. Neots", "Decking near St. Neots" ], "payment_methods": [ "Cash", "BACS" ], "contact_links": [ "https://www.facebook.com/profile.php?id=61563565050327", "https://instagram.com/apex_home_improvements_", "https://maps.app.goo.gl/jmigsbS9dTNUfPhcA" ], "overview": "

At Apex Home Improvements we offer a comprehensive range of professional garden design, hard and soft landscaping and grounds management to all commercial, industrial and domestic customers.

We work with YOU to ensure that all our landscaping meets YOUR requirements and exceeds YOUR expectations, we offer an expert and professional garden design service alongside the landscaping which is carried out to the highest standards.

We can undertake works on any size of garden and landscaping project and we offer a full and professional grounds management service to compliment your garden and landscaped areas.

We have a keen eye for detail and have plenty of ideas about what goes where and are always enthusiastic about brightening up someone's garden and trying to make them that little bit different!

From garden clearance to designing and building gardens from scratch we have completed many patios and interesting garden designs from concept to completion. Not only laying patios but fences, turfing jobs, turning unused areas of gardens into eye catching colourful areas and everything else in between.

If you have an area of the garden you just don't know what to do with then we can help you out, just take a quick look at the photos of some of the designs we have done.

", "photos": [ "https://c.yell.com/t_bigSquare,f_auto/afefe7d2-cd32-4b68-82e3-f5407a72ee06_image_jpeg.jpg", "https://c.yell.com/t_bigSquare,f_auto/dc29cf20-bbb7-4790-8c58-37b329f2a8a6_image_jpeg.jpg", "https://c.yell.com/t_bigSquare,f_auto/cfbbd244-1be5-47d6-8fd5-0ddb4ff83102_image_jpeg.jpg", "https://c.yell.com/t_bigSquare,f_auto/bb51cd7e-4242-4c96-9cd7-18a1eccb09bf_image_jpeg.jpg", "https://c.yell.com/t_bigSquare,f_auto/72268c34-c834-4f4c-947b-d90cb06bcd89_image_jpeg.jpg", "https://c.yell.com/t_bigSquare,f_auto/36033653-01d5-4171-9796-7906977f2873_image_jpeg.jpg", "https://c.yell.com/t_bigSquare,f_auto/5194ad73-83de-49b9-9417-a85f9240f573_image_jpeg.jpg", "https://c.yell.com/t_bigSquare,f_auto/67f99d20-cb64-4ef3-8e2d-ccdfabf374aa_image_jpeg.jpg", "https://c.yell.com/t_bigSquare,f_auto/e4ed2640-7399-4510-b144-86365d26d076_image_jpeg.jpg", "https://c.yell.com/t_bigSquare,f_auto/ee116a0a-bb89-458e-a1b2-66b8e8dd3bc6_image_jpeg.jpg", "https://c.yell.com/t_bigSquare,f_auto/4915f76f-f54f-434f-8b4b-c9a82417787c_image_jpeg.jpg", "https://c.yell.com/t_bigSquare,f_auto/ae3de9b7-3b65-4448-b61e-be35d6eb2e6a_image_jpeg.jpg", "https://c.yell.com/t_bigSquare,f_auto/d3782fcb-f7e6-43e1-ad6f-3d595e4600ce_image_jpeg.jpg", "https://c.yell.com/t_bigSquare,f_auto/fdad468c-d997-4e37-8255-b66e3b3a2ae5_image_jpeg.jpg", "https://c.yell.com/t_bigSquare,f_auto/19258976-fe82-4a3b-8e39-6cd01bbe39a3_image_jpeg.jpg", "https://c.yell.com/t_bigSquare,f_auto/1f0f9deb-c896-41cc-b762-88fa26251eb0_image_jpeg.jpg", "https://c.yell.com/t_bigSquare,f_auto/09e7d658-0d02-4a35-ae5b-3144145553b0_image_jpeg.jpg", "https://c.yell.com/t_bigSquare,f_auto/6b11defd-8bb9-487e-bded-b1aa89d6d3b7_image_jpeg.jpg", "https://c.yell.com/t_bigSquare,f_auto/6f5a6a10-5b4b-45d2-b3e8-536d3679f56d_image_jpeg.jpg", "https://c.yell.com/t_bigSquare,f_auto/f81160b3-3e0c-49ed-96ce-2cb4410f3d16_image_jpeg.jpg", "https://c.yell.com/t_bigSquare,f_auto/d9f21758-644c-442b-908d-05c799889b00_image_jpeg.jpg", "https://c.yell.com/t_bigSquare,f_auto/e2da4db4-aa81-4f16-8a1b-53d82929e58d_image_jpeg.jpg", "https://c.yell.com/t_bigSquare,f_auto/44bd4ccf-bdc2-44a2-8ae1-c73241363bc3_image_jpeg.jpg", "https://c.yell.com/t_bigSquare,f_auto/3f8c4de4-ac2b-43a5-aa35-d36211ef98a8_image_jpeg.jpg", "https://c.yell.com/t_bigSquare,f_auto/db30148a-7343-494f-8076-89089099b3b1_image_jpeg.jpg", "https://c.yell.com/t_bigSquare,f_auto/f04df082-5ae8-4174-91d7-54a88e028090_image_jpeg.jpg", "https://c.yell.com/t_bigSquare,f_auto/4a16f970-0c98-41e4-bb78-0be2cf52c5fd_image_jpeg.jpg", "https://c.yell.com/t_bigSquare,f_auto/9a1437af-6657-442f-987f-0a8b3ca5d847_image_jpeg.jpg", "https://c.yell.com/t_bigSquare,f_auto/56f8ccd8-c6b9-4ce6-9224-72f9f047ab46_image_jpeg.jpg", "https://c.yell.com/t_bigSquare,f_auto/58326830-d0df-4af7-877d-77d2aa0d9cdc_image_jpeg.jpg", "https://c.yell.com/t_bigSquare,f_auto/ebb466a1-28e3-46e0-88b6-8f02381b58b6_image_png.png", "https://c.yell.com/t_bigSquare,f_auto/be969ded-c79a-4887-9c3a-9f44ee09f408_image_png.png", "https://c.yell.com/t_bigSquare,f_auto/2f5055cc-333f-4686-ac80-e9ba44664309_image_png.png", "https://c.yell.com/t_bigSquare,f_auto/46e37b5d-f317-48c1-b704-574651a4f085_image_png.png", "https://c.yell.com/t_bigSquare,f_auto/b593cf60-76f8-42e8-80f7-26f849d2d792_image_png.png", "https://c.yell.com/t_bigSquare,f_auto/d923b365-241e-4c7a-8706-f73d8ebddb46_image_png.png", "https://c.yell.com/t_bigSquare,f_auto/a8fe6ed3-72b3-43b5-95e5-4ddedf7ff78e_image_png.png", "https://c.yell.com/t_bigSquare,f_auto/bab02911-b77e-49cc-b0e3-8a3376cd4aeb_image_png.png", "https://c.yell.com/t_bigSquare,f_auto/4dc2e509-9515-4f06-bffb-8de89fa62ff1_image_png.png", "https://c.yell.com/t_bigSquare,f_auto/881ea1f5-6b22-40f2-9c1c-9096ffef9b64_image_png.png", "https://c.yell.com/t_bigSquare,f_auto/cd68c924-fb49-4d3c-91de-c62900779705_image_png.png", "https://c.yell.com/t_bigSquare,f_auto/1fb89dab-20b5-4ce0-b654-f26d89a376e0_image_png.png", "https://c.yell.com/t_bigSquare,f_auto/1a211aa9-981a-4536-991a-5219b0709e50_image_png.png", "https://c.yell.com/t_bigSquare,f_auto/11e242c9-aaa3-4fa4-b553-446da31ec77d_image_png.png" ], "founding_date": null, "reputation_summary_amount": null, "has_offer_catalog": [ "Artificial Grass", "Decking", "Fencing Services", "Garden Clearance", "Garden Designers", "Garden Fencing", "Garden Maintenance", "Garden Makeovers", "Garden Walling", "Grounds Maintenance", "Hard Landscaping", "Hedge Cutting", "Hedging", "Lawn Care", "Lawns", "Lawn Mowing", "Patio Design", "Patios", "Site Clearance" ], "related_searches": [ { "url": "https://www.yell.com", "title": "Garden Services" }, { "url": "https://www.yell.com", "title": "Hedge Cutting" }, { "url": "https://www.yell.com", "title": "Landscapers" }, { "url": "https://www.yell.com", "title": "Turfing Services" }, { "url": "https://www.yell.com", "title": "Patio Laying" }, { "url": "https://www.yell.com", "title": "Hard Landscaping" }, { "url": "https://www.yell.com", "title": "Tree Surgeons" }, { "url": "https://www.yell.com", "title": "Garden Waste Removal" }, { "url": "https://www.yell.com", "title": "Builders" }, { "url": "https://www.yell.com", "title": "Roof Repairs" }, { "url": "https://www.yell.com", "title": "Handyman Services" }, { "url": "https://www.yell.com", "title": "Roofing Services" } ], "business_tenure": null } ] } } } } } }, "400": { "description": "Bad Request - Invalid URL format", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "404": { "description": "Not Found - Business not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" }, "examples": { "Example 1": { "value": { "statusCode": 500, "messageCode": "INTERNAL_SERVER_ERROR", "message": "Failed to run robot" } } } } } } }, "description": "Get detailed business information by URL\n\nRetrieves comprehensive business data", "summary": "Get detailed business information", "tags": [ "business" ], "security": [], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessDetailsRequest" } } } } } }, "/scrapers/api/yell/business/listing-by-url": { "post": { "operationId": "Get Business list By Url", "responses": { "200": { "description": "Successfully retrieved business information", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiSuccessResponse" }, "examples": { "Example 1": { "value": { "statusCode": 200, "messageCode": "OK", "data": [ { "id": "https://www.yellowbot.com/begins-cafe-los-angeles-ca.html", "url": "https://www.yellowbot.com/begins-cafe-los-angeles-ca.html", "title": "Begin's Cafe", "total_recommended": 10, "total_not_recommended": 1, "phone": "(213) 620-9565", "address": { "full_address": "100 S Main St, Los Angeles, CA 90012", "city": "Los Angeles", "zipcode": "90012" }, "tags": [ { "url": "https://www.yellowbot.com/tags/american/Los%20Angeles%2C%20CA/page1.html", "name": "American" }, { "url": "https://www.yellowbot.com/tags/americantraditional/Los%20Angeles%2C%20CA/page1.html", "name": "American Traditional" }, { "url": "https://www.yellowbot.com/tags/bioresearchemcom/Los%20Angeles%2C%20CA/page1.html", "name": "bioresearchem.com" }, { "url": "https://www.yellowbot.com/tags/breakfast/Los%20Angeles%2C%20CA/page1.html", "name": "Breakfast" }, { "url": "https://www.yellowbot.com/tags/cafe/Los%20Angeles%2C%20CA/page1.html", "name": "Cafe" }, { "url": "https://www.yellowbot.com/tags/cafeteria/Los%20Angeles%2C%20CA/page1.html", "name": "Cafeteria" }, { "url": "https://www.yellowbot.com/tags/casual/Los%20Angeles%2C%20CA/page1.html", "name": "Casual" }, { "url": "https://www.yellowbot.com/tags/cookies/Los%20Angeles%2C%20CA/page1.html", "name": "cookies" }, { "url": "https://www.yellowbot.com/tags/food/Los%20Angeles%2C%20CA/page1.html", "name": "food" }, { "url": "https://www.yellowbot.com/tags/goodforgroups/Los%20Angeles%2C%20CA/page1.html", "name": "Good for Groups" }, { "url": "https://www.yellowbot.com/tags/mobileappdevelopment/Los%20Angeles%2C%20CA/page1.html", "name": "mobile app development" }, { "url": "https://www.yellowbot.com/tags/none/Los%20Angeles%2C%20CA/page1.html", "name": "None" }, { "url": "https://www.yellowbot.com/tags/notnecessary/Los%20Angeles%2C%20CA/page1.html", "name": "Not Necessary" }, { "url": "https://www.yellowbot.com/tags/offshorewebdesignanddevelopment/Los%20Angeles%2C%20CA/page1.html", "name": "offshore webdesign and development" }, { "url": "https://www.yellowbot.com/tags/pizza/Los%20Angeles%2C%20CA/page1.html", "name": "pizza" }, { "url": "https://www.yellowbot.com/tags/sandwiches/Los%20Angeles%2C%20CA/page1.html", "name": "Sandwiches" }, { "url": "https://www.yellowbot.com/tags/street/Los%20Angeles%2C%20CA/page1.html", "name": "Street" }, { "url": "https://www.yellowbot.com/tags/takeout/Los%20Angeles%2C%20CA/page1.html", "name": "Take-out" }, { "url": "https://www.yellowbot.com/tags/tea/Los%20Angeles%2C%20CA/page1.html", "name": "Tea" }, { "url": "https://www.yellowbot.com/tags/websitedevelopment/Los%20Angeles%2C%20CA/page1.html", "name": "website development" } ], "from_url": "https://www.yellowbot.com/browse/pizza/Los%20Angeles%2C%20CA/page1.html" } ] } } } } } }, "400": { "description": "Bad Request - Invalid URL format", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "404": { "description": "Not Found - Business not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" }, "examples": { "Example 1": { "value": { "statusCode": 500, "messageCode": "INTERNAL_SERVER_ERROR", "message": "Failed to run robot" } } } } } } }, "description": "Get list of basic business information by URL\n\nRetrieves essential business data without extensive financial history.\nUse this endpoint for faster queries when full details are not needed.", "summary": "Get list basic business information", "tags": [ "business" ], "security": [], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessListRequest" } } } } } }, "/scrapers/api/yell/business/search": { "get": { "operationId": "Search Business", "responses": { "200": { "description": "Successfully retrieved search results", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiSuccessResponse" }, "examples": { "Example 1": { "value": { "statusCode": 200, "messageCode": "OK", "data": [ { "id": "https://www.yellowbot.com/begins-cafe-los-angeles-ca.html", "url": "https://www.yellowbot.com/begins-cafe-los-angeles-ca.html", "title": "Begin's Cafe", "total_recommended": 10, "total_not_recommended": 1, "phone": "(213) 620-9565", "address": { "full_address": "100 S Main St, Los Angeles, CA 90012", "city": "Los Angeles", "zipcode": "90012" }, "tags": [ { "url": "https://www.yellowbot.com/tags/american/Los%20Angeles%2C%20CA/page1.html", "name": "American" }, { "url": "https://www.yellowbot.com/tags/americantraditional/Los%20Angeles%2C%20CA/page1.html", "name": "American Traditional" }, { "url": "https://www.yellowbot.com/tags/bioresearchemcom/Los%20Angeles%2C%20CA/page1.html", "name": "bioresearchem.com" }, { "url": "https://www.yellowbot.com/tags/breakfast/Los%20Angeles%2C%20CA/page1.html", "name": "Breakfast" }, { "url": "https://www.yellowbot.com/tags/cafe/Los%20Angeles%2C%20CA/page1.html", "name": "Cafe" }, { "url": "https://www.yellowbot.com/tags/cafeteria/Los%20Angeles%2C%20CA/page1.html", "name": "Cafeteria" }, { "url": "https://www.yellowbot.com/tags/casual/Los%20Angeles%2C%20CA/page1.html", "name": "Casual" }, { "url": "https://www.yellowbot.com/tags/cookies/Los%20Angeles%2C%20CA/page1.html", "name": "cookies" }, { "url": "https://www.yellowbot.com/tags/food/Los%20Angeles%2C%20CA/page1.html", "name": "food" }, { "url": "https://www.yellowbot.com/tags/goodforgroups/Los%20Angeles%2C%20CA/page1.html", "name": "Good for Groups" }, { "url": "https://www.yellowbot.com/tags/mobileappdevelopment/Los%20Angeles%2C%20CA/page1.html", "name": "mobile app development" }, { "url": "https://www.yellowbot.com/tags/none/Los%20Angeles%2C%20CA/page1.html", "name": "None" }, { "url": "https://www.yellowbot.com/tags/notnecessary/Los%20Angeles%2C%20CA/page1.html", "name": "Not Necessary" }, { "url": "https://www.yellowbot.com/tags/offshorewebdesignanddevelopment/Los%20Angeles%2C%20CA/page1.html", "name": "offshore webdesign and development" }, { "url": "https://www.yellowbot.com/tags/pizza/Los%20Angeles%2C%20CA/page1.html", "name": "pizza" }, { "url": "https://www.yellowbot.com/tags/sandwiches/Los%20Angeles%2C%20CA/page1.html", "name": "Sandwiches" }, { "url": "https://www.yellowbot.com/tags/street/Los%20Angeles%2C%20CA/page1.html", "name": "Street" }, { "url": "https://www.yellowbot.com/tags/takeout/Los%20Angeles%2C%20CA/page1.html", "name": "Take-out" }, { "url": "https://www.yellowbot.com/tags/tea/Los%20Angeles%2C%20CA/page1.html", "name": "Tea" }, { "url": "https://www.yellowbot.com/tags/websitedevelopment/Los%20Angeles%2C%20CA/page1.html", "name": "website development" } ], "from_url": "https://www.yellowbot.com/browse/pizza/Los%20Angeles%2C%20CA/page1.html" } ] } } } } } }, "400": { "description": "Bad Request - Invalid search parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" }, "examples": { "Example 1": { "value": { "statusCode": 500, "messageCode": "INTERNAL_SERVER_ERROR", "message": "Failed to run robot" } } } } } } }, "description": "Search for businesses\n\nSearch businesses in the Yell database using keyword and optional filters.\nSupports pagination for large result sets.\n\nCommon search strategies:\n- Search by company name: `keyword=acme`\n- Search by organization number: `keyword=556570-4789`\n- Filter by location: `keyword=restaurang&municipality=Stockholm`", "summary": "Search businesses with filters", "tags": [ "business" ], "security": [], "parameters": [ { "description": "Search term to find bussiness on yell.com (only for filter-based scraping)", "in": "query", "name": "keyword", "required": true, "schema": { "type": "string" }, "example": "Butchers" }, { "description": "The location find bussiness (e.g., Country, City, Town or Postcode)", "in": "query", "name": "location", "required": false, "schema": { "type": "string" }, "example": "united kingdom" }, { "description": "Page number for pagination (starts from 1)", "in": "query", "name": "page", "required": false, "schema": { "format": "int32", "type": "integer", "minimum": 1 }, "example": 1 } ] } } }, "servers": [ { "url": "/undefined" } ] }