{"id":18287581,"url":"https://github.com/wfgilman/yodlee-elixir","last_synced_at":"2025-04-05T08:31:54.025Z","repository":{"id":48579431,"uuid":"137121906","full_name":"wfgilman/yodlee-elixir","owner":"wfgilman","description":"An Elixir library for Yodlee","archived":false,"fork":false,"pushed_at":"2021-07-19T19:01:33.000Z","size":18,"stargazers_count":3,"open_issues_count":1,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-10-16T09:36:02.492Z","etag":null,"topics":["elixir","yodlee"],"latest_commit_sha":null,"homepage":null,"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/wfgilman.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":"2018-06-12T20:05:46.000Z","updated_at":"2024-03-08T08:02:06.000Z","dependencies_parsed_at":"2022-09-26T20:00:51.771Z","dependency_job_id":null,"html_url":"https://github.com/wfgilman/yodlee-elixir","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wfgilman%2Fyodlee-elixir","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wfgilman%2Fyodlee-elixir/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wfgilman%2Fyodlee-elixir/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wfgilman%2Fyodlee-elixir/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wfgilman","download_url":"https://codeload.github.com/wfgilman/yodlee-elixir/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223176038,"owners_count":17100559,"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":["elixir","yodlee"],"created_at":"2024-11-05T13:28:22.576Z","updated_at":"2024-11-05T13:28:23.283Z","avatar_url":"https://github.com/wfgilman.png","language":"Elixir","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Yodlee\n\n[![Build Status](https://travis-ci.org/wfgilman/yodlee-elixir.svg?branch=master)](https://travis-ci.org/wfgilman/yodlee-elixir)\n[![Hex.pm Version](https://img.shields.io/hexpm/v/yodlee_elixir.svg)](https://hex.pm/packages/yodlee_elixir)\n\nElixir library for Yodlee's v1.0 API\n\nSupported Yodlee endpoints:\n- [x] Cobrand\n- [x] User\n- [x] Accounts\n- [ ] Holdings\n- [x] Providers\n- [x] ProviderAccounts\n- [x] Transactions\n- [ ] Statements\n- [ ] Derived\n- [x] DataExtracts\n- [ ] Refresh\n\n## Usage\n\nAdd to your dependencies in `mix.exs`. The hex specification is required.\n\n```elixir\ndef deps do\n  [{:yodlee, \"~\u003e 0.1\", hex: :yodlee_elixir}]\nend\n```\n\n## Configuration\n\nAdd the following configuration to your project.\n\n```elixir\nconfig :yodlee,\n  root_uri: \"https://developer.api.yodlee.com/ysl/restserver/v1/\",\n  cob_session: nil,\n  cobrand_login: \"your_cobrand_username\",\n  cobrand_password: \"your_cobrand_password\",\n  httpoison_options: [timeout: 10_000, recv_timeout: 100_000]\n```\n\n## Getting Started\n\nHere's a few usage examples for getting started (courtesy of [tmaszk](https://github.com/tmaszk)).\n\n\n#### Logging in\n\nEstablishing a Cobrand session\n```elixir\niex(1)\u003e {:ok, cobrand} = Yodlee.Cobrand.login()\n{:ok,\n %Yodlee.Cobrand{\n   application_id: \"XXXXX\",\n   cobrand_id: 10...,\n   locale: \"en_US\",\n   session: \"08...\"\n }}\n```\n\nEstablishing a User session (required for most API calls)\n```elixir\niex(2)\u003e {:ok, user} = Yodlee.User.login(cobrand.session, %{ loginName: \"YourCobrandLoginName\", password: \"YourCobrandPassword\", email: \"YourEmailAddress\" })\n{:ok,\n %Yodlee.User{\n   id: 10...,\n   login_name: \"..\",\n   session: \"08...\"\n }}\n```\n\n#### Linking a Provider Account\n\nI recommend using Yodlee's FastLink for facilitating the addition and updating of Provider\nAccounts due to the complexity and ever-changing nature of Provider login and MFA\nchallenges. FastLink is fully supported by Yodlee.\n\n#### Fetching User Data\n\nSearching Providers\n```elixir\niex(3)\u003e Yodlee.Provider.search(user.session, %{ name: \"Hamilton\"} )\n{:ok,\n [\n   %Yodlee.Provider{\n     auth_type: \"MFA_CREDENTIALS\",\n     base_url: \"http://www.hamiltonstatebank.com/\",\n     container_names: [\"loan\", \"bank\"],\n     ...\n   },\n   %Yodlee.Provider{...},\n   ...\n ]}\n```\n\nGetting Transactions from a linked User Account\n```elixir\niex(4)\u003e {:ok, accounts} = Yodlee.Account.list(user.session)\n{:ok,\n [\n   %Yodlee.Account{\n     account_name: \"DDA\",\n     account_number: \"...\",\n     account_status: \"ACTIVE\",\n     account_type: \"CHECKING\",\n     ....\n   },\n   %Yodlee.Account{...},\n   ...\n ]}\n\niex(5)\u003e {:ok, transactions} = Yodlee.Transaction.list(user.session, \"bank\", hd(accounts).id)\n{:ok,\n [\n   %Yodlee.Transaction{\n     account_id: 100....,\n     amount: %Yodlee.Money{amount: 6268.87, currency: \"USD\"},\n     base_type: \"CREDIT\",\n     container: \"bank\",\n     date: \"2018-07-06\",\n     id: 910000,\n     interest: nil,\n     principal: nil,\n     status: \"PENDING\"\n   },\n   %Yodlee.Transaction{...},\n   ...\n ]}\n```\n\n\n## Tests and Style\n\nThis library has sparse test coverage at the moment.\n\nRun tests using `mix test`.\n\nBefore making pull requests, run the coverage and style checks.\n```elixir\nmix coveralls\nmix credo\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwfgilman%2Fyodlee-elixir","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwfgilman%2Fyodlee-elixir","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwfgilman%2Fyodlee-elixir/lists"}