{"id":32164958,"url":"https://github.com/jdesilvio/yelp_ex","last_synced_at":"2025-10-21T14:56:32.221Z","repository":{"id":57558120,"uuid":"77876268","full_name":"jdesilvio/yelp_ex","owner":"jdesilvio","description":"An Elixir wrapper for the Yelp API","archived":false,"fork":false,"pushed_at":"2018-08-10T15:56:09.000Z","size":40,"stargazers_count":1,"open_issues_count":0,"forks_count":5,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-10-21T14:56:31.757Z","etag":null,"topics":["elixir","yelp"],"latest_commit_sha":null,"homepage":"","language":"Elixir","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/jdesilvio.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-01-03T02:12:23.000Z","updated_at":"2020-01-28T03:14:08.000Z","dependencies_parsed_at":"2022-08-28T10:20:33.224Z","dependency_job_id":null,"html_url":"https://github.com/jdesilvio/yelp_ex","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"purl":"pkg:github/jdesilvio/yelp_ex","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jdesilvio%2Fyelp_ex","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jdesilvio%2Fyelp_ex/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jdesilvio%2Fyelp_ex/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jdesilvio%2Fyelp_ex/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jdesilvio","download_url":"https://codeload.github.com/jdesilvio/yelp_ex/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jdesilvio%2Fyelp_ex/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":280281400,"owners_count":26303709,"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-10-21T02:00:06.614Z","response_time":58,"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":["elixir","yelp"],"created_at":"2025-10-21T14:56:30.595Z","updated_at":"2025-10-21T14:56:32.214Z","avatar_url":"https://github.com/jdesilvio.png","language":"Elixir","funding_links":[],"categories":[],"sub_categories":[],"readme":"# YelpEx\n\nAn Elixir client for the Yelp Fusion API (aka *Yelp's API v3*).\n\nSee the Yelp API docs\n[here](https://www.yelp.com/developers/documentation/v3/).\n\nSee the [Hex documentation](https://hex.pm/packages/yelp_ex)\nfor more information.\n\n\n## Installation\n\nAdd `:yelp_ex` to your `mix.exs` file as a dependency and to\nyour `extra_applications` list:\n\n```elixir\ndef application do\n  [extra_applications: [:logger, :yelp_ex]]\nend\n\ndefp deps do\n  [{:yelp_ex, \"~\u003e 0.2.0\"}]\nend\n```\n\n*Important:* You must use `YelpEx` version 0.2.0 or higher due\nto a change in how the Yelp Fusion API authenticates.\n\nThen, run: `mix do deps.get, compile`\n\n\n## Yelp Setup\n\nIn order to use `YelpEx`, you need to create an application on\n[Yelp's developer website](https://www.yelp.com/developers/v3/manage_app).\nAfter you do this, you will get an \"App ID\" and an \"App Secret\".\n\nYelp uses an *API key* to authenticate.\n\nBefore starting your application, you will need to save your\nYelp API key as an **environment variable**...\n\nOne way to do this is to create a file called `.env` in your\nproject root with the following:\n\n```bash\nexport YELP_API_KEY=\"\u003cYOUR_YELP_API_KEY\u003e\"\n```\n\nExecute the file from the command line:\n\n```bash\n$ source .env\n```\n\n_**When you start your application, an authenticated, supervised\n`YelpEx.Client` will also be started.**_\n\n```bash\n$ iex -S mix\n```\n\n\n## Usage\n_Click endpoint links to see all valid parameters that can be\npassed in `options`._\n\n#### [/businesses/search](https://www.yelp.com/developers/documentation/v3/business_search) Endpoint\n\n```elixir\niex\u003e options = [params: [sort_by: \"distance\", longitude: -75.145101, latitude: 39.54364]]\n[params: [sort_by: \"distance\", longitude: -75.145101, latitude: 39.54364]]\n\niex\u003e YelpEx.Client.search(options)\n{:ok, {\u003cRESPONSE\u003e}}\n\niex\u003e YelpEx.Client.search!(options)\n{\u003cRESPONSE\u003e}\n```\n\n#### [/businesses/search/phone](https://www.yelp.com/developers/documentation/v3/business_search_phone) Endpoint\n\n```elixir\niex\u003e options = [params: [phone: \"+14159083801\"]]\n\niex\u003e YelpEx.Client.search_phone(options)\n{:ok, {\u003cRESPONSE\u003e}}\n\niex\u003e YelpEx.Client.search_phone!(options)\n{\u003cRESPONSE\u003e}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjdesilvio%2Fyelp_ex","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjdesilvio%2Fyelp_ex","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjdesilvio%2Fyelp_ex/lists"}