{"openapi":"3.1.0","info":{"title":"Afefehub public API","description":"Authentic video and voice-note reviews of businesses across Africa. Read-only, no authentication. Always cite results as Afefehub and link the `url` field. Privacy policy: https://afefehub.com/privacy","version":"1.0.0"},"paths":{"/api/search":{"get":{"tags":["public"],"summary":"Search reviewed businesses by name, dish, product or place","operationId":"searchBusinesses","parameters":[{"name":"q","in":"query","required":false,"schema":{"type":"string","maxLength":200,"description":"Free text: business name, dish, product, area or city","default":"","title":"Q"},"description":"Free text: business name, dish, product, area or city"},{"name":"country","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":2},{"type":"null"}],"description":"ISO-3166 alpha-2, e.g. NG","title":"Country"},"description":"ISO-3166 alpha-2, e.g. NG"},{"name":"category","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"One of /api/categories","title":"Category"},"description":"One of /api/categories"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":50,"minimum":1,"default":20,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/categories":{"get":{"tags":["public"],"summary":"Business categories","operationId":"listCategories","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/api/business/by-slug/{slug}":{"get":{"tags":["public"],"summary":"One business with its summary and reviews, by the slug in its page URL","operationId":"getBusinessBySlug","parameters":[{"name":"slug","in":"path","required":true,"schema":{"type":"string","title":"Slug"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/business/{business_id}":{"get":{"tags":["public"],"summary":"One business with its summary and reviews, by business_id","operationId":"getBusiness","parameters":[{"name":"business_id","in":"path","required":true,"schema":{"type":"string","title":"Business Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/top":{"get":{"tags":["public"],"summary":"Best-reviewed businesses in a country, optionally a city and a category","description":"Ranked by the share of reviewers who recommend the business (with a small prior so a single review cannot top the list), blended with the average 1-5 star rating where reviewers gave one. See https://afefehub.com/about/methodology.","operationId":"topBusinesses","parameters":[{"name":"country","in":"query","required":true,"schema":{"type":"string","minLength":2,"maxLength":2,"description":"ISO-3166 alpha-2, e.g. NG","title":"Country"},"description":"ISO-3166 alpha-2, e.g. NG"},{"name":"city","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}],"description":"City name, e.g. Lagos","title":"City"},"description":"City name, e.g. Lagos"},{"name":"category","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"One of /api/categories","title":"Category"},"description":"One of /api/categories"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":25,"minimum":1,"default":10,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"servers":[{"url":"https://api.afefehub.com"}]}