{"id":22668636,"url":"https://github.com/lanl/yelpapi","last_synced_at":"2026-04-02T10:47:13.241Z","repository":{"id":10989275,"uuid":"13309647","full_name":"lanl/yelpapi","owner":"lanl","description":"yelpapi is a pure Python implementation of the Yelp Fusion API (aka Yelp v3 API).","archived":false,"fork":false,"pushed_at":"2023-10-13T20:38:53.000Z","size":127,"stargazers_count":135,"open_issues_count":0,"forks_count":48,"subscribers_count":9,"default_branch":"master","last_synced_at":"2024-04-26T12:43:26.784Z","etag":null,"topics":["api","python","python-yelp","yelp"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/lanl.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGES.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2013-10-03T20:55:21.000Z","updated_at":"2024-03-16T10:18:14.000Z","dependencies_parsed_at":"2023-10-14T21:13:56.937Z","dependency_job_id":null,"html_url":"https://github.com/lanl/yelpapi","commit_stats":{"total_commits":109,"total_committers":8,"mean_commits":13.625,"dds":"0.25688073394495414","last_synced_commit":"5ce2b4fd0deacdab34750d70d827b2ddfa2c47be"},"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lanl%2Fyelpapi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lanl%2Fyelpapi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lanl%2Fyelpapi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lanl%2Fyelpapi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lanl","download_url":"https://codeload.github.com/lanl/yelpapi/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247361615,"owners_count":20926642,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","python","python-yelp","yelp"],"created_at":"2024-12-09T15:16:04.811Z","updated_at":"2026-04-02T10:47:13.237Z","avatar_url":"https://github.com/lanl.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# yelpapi\n\n[![Tests](https://github.com/lanl/yelpapi/actions/workflows/tests.yml/badge.svg)](https://github.com/lanl/yelpapi/actions/workflows/tests.yml)\n\n## LICENSE\nThis software is licensed under the [BSD 3-Clause License](http://opensource.org/licenses/BSD-3-Clause). Please refer to the separate [LICENSE](LICENSE) file for the exact text of the license. You are obligated to give attribution if you use this code.\n\n## ABOUT\nyelpapi is a pure Python implementation of the [Yelp Fusion API](https://docs.developer.yelp.com/docs/fusion-intro). It is simple, fast, and robust to any changes Yelp may make to the API in the future.\n\n## REQUIREMENTS\nThis code requires Python 3.9 or higher and [requests](https://github.com/requests/requests).\n\n## INSTALL\nyelpapi is available on PyPI at https://pypi.org/project/yelpapi/.\n\nInstall using [pip](http://www.pip-installer.org/):\n\n    pip install yelpapi\n\n## USING THIS CODE\nThis API is demonstrated more thoroughly in [examples.py](examples/examples.py), but the following chunk of code demonstrates basic use of yelpapi:\n\n```python\nfrom yelpapi import YelpAPI\nwith YelpAPI(api_key) as yelp_api:\n    search_results = yelp_api.search_query(args)\n```\n\nYou can also set timeouts so API calls do not block indefinitely in degraded network conditions:\n\n```python\nfrom yelpapi import YelpAPI\nwith YelpAPI(api_key, timeout_s=3.0) as yelp_api:\n    search_results = yelp_api.search_query(args)\n```\n\nUnder the covers, this module uses a [`requests.Session`](https://requests.readthedocs.io/en/latest/user/advanced/#session-objects) object for issuing all API calls, which offers potentially significant performance benefits over issuing separate API calls outside of a session. You should be sure to close the underlying session when all API interactions are complete. The above examples demonstrate using the class as a context manager, which will automatically close the connection when you're done and is the preferred way of using the class, but you can also manually close it like this if a context manager won't work for your use case:\n\n```python\nfrom yelpapi import YelpAPI\ntry:\n    yelp_api = YelpAPI(api_key)\n    search_results = yelp_api.search_query(args)\nfinally:\n    yelp_api.close()\n```\n\n## METHODS\n* [Autocomplete API](https://docs.developer.yelp.com/reference/v3_autocomplete) - `autocomplete_query(...)`\n* [Business API](https://docs.developer.yelp.com/reference/v3_business_info) - `business_query(...)`\n* [Business Engagement Metrics API](https://docs.developer.yelp.com/reference/v3_get_businesses_engagement) - `business_engagement_query(...)`\n* [Business Match API](https://docs.developer.yelp.com/reference/v3_business_match) - `business_match_query(...)`\n* [Business Service Offerings API](https://docs.developer.yelp.com/reference/v3_business_service_offerings) - `business_service_offerings_query(...)`\n* [Categories API](https://docs.developer.yelp.com/reference/v3_all_categories) - `categories_query(...)`\n* [Category API](https://docs.developer.yelp.com/reference/v3_categories) - `category_query(...)`\n* [Event Lookup API](https://docs.developer.yelp.com/reference/v3_event) - `event_lookup_query(...)`\n* [Event Search API](https://docs.developer.yelp.com/reference/v3_events_search) - `event_search_query(...)`\n* [Featured Event API](https://docs.developer.yelp.com/reference/v3_featured_event) - `featured_event_query(...)`\n* [Phone Search API](https://docs.developer.yelp.com/reference/v3_business_phone_search) - `phone_search_query(...)`\n* [Review Highlights API](https://docs.developer.yelp.com/reference/v3_business_review_highlights) - `review_highlights_query(...)`\n* [Reviews API](https://docs.developer.yelp.com/reference/v3_business_reviews) - `reviews_query(...)`\n* [Search API](https://docs.developer.yelp.com/reference/v3_business_search) - `search_query(...)`\n* [Transaction Search API](https://docs.developer.yelp.com/reference/v3_transaction_search) - `transaction_search_query(...)`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flanl%2Fyelpapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flanl%2Fyelpapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flanl%2Fyelpapi/lists"}