{"id":16942787,"url":"https://github.com/jmettraux/avantage","last_synced_at":"2025-04-11T19:32:43.265Z","repository":{"id":62553802,"uuid":"191879495","full_name":"jmettraux/avantage","owner":"jmettraux","description":"A Ruby client to the Alpha Vantage API","archived":false,"fork":false,"pushed_at":"2020-09-25T14:54:36.000Z","size":12,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-25T15:21:28.076Z","etag":null,"topics":["alphavantage","ruby"],"latest_commit_sha":null,"homepage":null,"language":"Ruby","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/jmettraux.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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":"2019-06-14T05:13:39.000Z","updated_at":"2023-07-14T07:43:31.000Z","dependencies_parsed_at":"2022-11-03T04:45:36.859Z","dependency_job_id":null,"html_url":"https://github.com/jmettraux/avantage","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jmettraux%2Favantage","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jmettraux%2Favantage/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jmettraux%2Favantage/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jmettraux%2Favantage/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jmettraux","download_url":"https://codeload.github.com/jmettraux/avantage/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247980821,"owners_count":21027803,"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":["alphavantage","ruby"],"created_at":"2024-10-13T21:12:57.782Z","updated_at":"2025-04-11T19:32:43.242Z","avatar_url":"https://github.com/jmettraux.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n# avantage\n\n[![Gem Version](https://badge.fury.io/rb/avantage.svg)](http://badge.fury.io/rb/avantage)\n\nA Ruby library to query the [Alpha Vantage API](https://www.alphavantage.co/documentation/).\n\n\n## usage\n\nThe first step is to instantiate a client:\n```ruby\nrequire 'avantage'\n\nclient = Avantage::Client.new('6SAMPLEWO0KLUG55')\n  # or more something like\nclient = Avantage::Client.new(File.read('.api.key').strip)\n```\n\nFunctions may be called directly:\n```ruby\nrequire 'pp'\n\npp client.get(:global_quote, symbol: 'GOOG')\n  #\n  # ==\u003e\n  #\n  # {\"Global Quote\"=\u003e\n  #   {\"01. symbol\"=\u003e\"GOOG\",\n  #    \"02. open\"=\u003e\"1109.6900\",\n  #    \"03. high\"=\u003e\"1116.3900\",\n  #    \"04. low\"=\u003e\"1098.9995\",\n  #    \"05. price\"=\u003e\"1103.6000\",\n  #    \"06. volume\"=\u003e\"1386684\",\n  #    \"07. latest trading day\"=\u003e\"2019-06-18\",\n  #    \"08. previous close\"=\u003e\"1092.5000\",\n  #    \"09. change\"=\u003e\"11.1000\",\n  #    \"10. change percent\"=\u003e\"1.0160%\"}}\n```\n\nGLOBAL_QUOTE, SYMBOL_SEARCH, CURRENCY_EXCHANGE_RATE, and SECTOR can be called directly:\n```ruby\nclient.global_quote('GOOG')\nclient.global_quote(symbol: 'GOOG')\nclient.global_quote(symbol: 'GOOG', datatype: 'csv')\nclient.quote('GOOG')\n# ...\n\nclient.symbol_search(keywords: 'IBM')\nclient.symbol_search('IBM')\nclient.search(keywords: 'IBM')\nclient.search('IBM')\nclient.search(keywords: 'IBM', datatype: 'csv')\n# ...\n\nclient.currency_exchange_rate('USD', 'JPY')\nclient.exchange_rate('USD', 'JPY')\nclient.exchange_rate(from: 'USD', to: 'JPY')\nclient.exchange_rate(from_currency: 'USD', to_currency: 'JPY')\nclient.forex(from: 'USD', to: 'JPY')\nclient.forex('USD', 'JPY')\nclient.forex(from: 'USD', to: 'JPY', datatype: 'csv')\n# ...\n\nclient.sectors\nclient.sector\nclient.sectors(datatype: 'csv')\n# ...\n```\n\n\n## license\n\nMIT, see [LICENSE.txt](LICENSE.txt)\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjmettraux%2Favantage","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjmettraux%2Favantage","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjmettraux%2Favantage/lists"}