{"id":30218405,"url":"https://github.com/yelp/yelp-python","last_synced_at":"2025-08-14T06:35:24.232Z","repository":{"id":62590559,"uuid":"43325065","full_name":"Yelp/yelp-python","owner":"Yelp","description":"A Python library for the Yelp API","archived":false,"fork":false,"pushed_at":"2020-06-17T14:08:13.000Z","size":257,"stargazers_count":183,"open_issues_count":11,"forks_count":109,"subscribers_count":19,"default_branch":"master","last_synced_at":"2025-07-25T17:14:02.216Z","etag":null,"topics":["api-client","python"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Yelp.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-09-28T20:26:42.000Z","updated_at":"2025-04-26T03:26:46.000Z","dependencies_parsed_at":"2022-11-04T07:17:55.156Z","dependency_job_id":null,"html_url":"https://github.com/Yelp/yelp-python","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/Yelp/yelp-python","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Yelp%2Fyelp-python","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Yelp%2Fyelp-python/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Yelp%2Fyelp-python/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Yelp%2Fyelp-python/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Yelp","download_url":"https://codeload.github.com/Yelp/yelp-python/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Yelp%2Fyelp-python/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":270377840,"owners_count":24573416,"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","status":"online","status_checked_at":"2025-08-14T02:00:10.309Z","response_time":75,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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-client","python"],"created_at":"2025-08-14T06:35:13.640Z","updated_at":"2025-08-14T06:35:24.218Z","avatar_url":"https://github.com/Yelp.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Build Status](https://travis-ci.org/Yelp/yelp-python.svg?branch=master)](https://travis-ci.org/Yelp/yelp-python)\n[![Coverage Status](https://img.shields.io/coveralls/Yelp/yelp-python.svg?branch=master)](https://coveralls.io/r/Yelp/yelp-python)\n\n# yelp-python\n\nA Python library for the [Yelp Fusion API](https://www.yelp.com/developers/documentation/v3/get_started). It simplifies the process of request construction, and response parsing for Python developers. This clientlib is built and tested on Python 2.7 and 3.6.\n\nPlease file issues on this repository for bugs/feature requests for this python client. For bugs/features requests for the Yelp Fusion API itself, please open issues on the [dedicated Yelp Fusion repository](https://github.com/Yelp/yelp-fusion).\n\n\n## Installation\n\nInstall yelp-python from PyPI using:\n\n    pip install yelp\n\n## Usage\n\n### Basics\n\nYou must have a Yelp Fusion API key to make requests to the API. Sign up for an API key at https://www.yelp.com/developers/v3/manage_app. Instantiate `yelp.client.Client` with your API key, and start making requests!\n\n```\nfrom yelp.client import Client\n\nMY_API_KEY = \"abcefghijklmnopqrstuvqwxy123456789\" #  Replace this with your real API key\n\nclient = Client(MY_API_KEY)\n```\n\nNow you can use the client object to make requests.\n\n### Business Details Endpoint\n\nEndpoint documentation: https://www.yelp.com/developers/documentation/v3/business\n\nTo query the Business Details Endpoint use the `busines.get_by_id` function with a Yelp business alias (i.e. `yelp-san-francisco`) or ID (i.e. `4kMBvIEWPxWkWKFN__8SxQ`). You can also pass in the locale parameter as specified in the [Business Details Endpoint Documentation](https://www.yelp.com/developers/documentation/v3/business).\n\n```\n\u003e business_response = client.business.get_by_id('yelp-san-francisco')\n\n\u003e business_response\nBusiness(alias='yelp-san-francisco', attributes=None, categories=[Category(alias='massmedia', title='Mass Media')], coordinates=Coordinates(latitude=37.7867703362929, longitude=-122.399958372115), display_phone='(415) 908-3801', hours=[Hours(hours_type='REGULAR', is_open_now=True, open=[DayHours(day=0, end='1800', is_overnight=False, start='0800'), DayHours(day=1, end='1800', is_overnight=False, start='0800'), DayHours(day=2, end='1800', is_overnight=False, start='0800'), DayHours(day=3, end='1800', is_overnight=False, start='0800'), DayHours(day=4, end='1800', is_overnight=False, start='0800')])], id='4kMBvIEWPxWkWKFN__8SxQ', image_url='https://s3-media2.fl.yelpcdn.com/bphoto/nQK-6_vZMt5n88zsAS94ew/o.jpg', is_claimed=True, is_closed=False, location=Location(address1='140 New Montgomery St', address2='', address3='', city='San Francisco', country='US', cross_streets='Natoma St \u0026 Minna St', display_address=['140 New Montgomery St', 'San Francisco, CA 94105'], state='CA', zip_code='94105'), name='Yelp', phone='+14159083801', photos=['https://s3-media2.fl.yelpcdn.com/bphoto/nQK-6_vZMt5n88zsAS94ew/o.jpg', 'https://s3-media2.fl.yelpcdn.com/bphoto/yFHIb9gob4TzhKUemMOPww/o.jpg', 'https://s3-media1.fl.yelpcdn.com/bphoto/EHCfkEpZraIfPl8gvCo1tg/o.jpg'], rating=2.0, review_count=8421, transactions=[], url='https://www.yelp.com/biz/yelp-san-francisco?adjust_creative=wpr6gw4FnptTrk1CeT8POg\u0026utm_campaign=yelp_api_v3\u0026utm_medium=api_v3_business_lookup\u0026utm_source=wpr6gw4FnptTrk1CeT8POg')\n```\n\n## Contributing\n\n1. Fork it (http://github.com/yelp/yelp-python/fork)\n2. Setup your virtual environment\n```\n$ pip install tox\n$ tox -e venv\n$ . venv-yelp/bin/activate\n```\n3. Create your feature branch (git checkout -b my-new-feature)\n4. Commit your changes (git commit -am 'Add some feature')\n5. Push to the branch (git push origin my-new-feature)\n6. Create new Pull Request\n\n### Testing\n\nPlease write tests for any new features. We use pytest + tox so just run `tox` to run the full test suite.  Full py.test documentation [here](http://pytest.org/latest/contents.html).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyelp%2Fyelp-python","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyelp%2Fyelp-python","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyelp%2Fyelp-python/lists"}