{"id":15288018,"url":"https://github.com/finbits/pluggy_elixir","last_synced_at":"2025-10-07T02:32:03.009Z","repository":{"id":45141864,"uuid":"361226099","full_name":"Finbits/pluggy_elixir","owner":"Finbits","description":"A client library for Pluggy.ai API","archived":true,"fork":false,"pushed_at":"2022-01-05T18:18:28.000Z","size":105,"stargazers_count":3,"open_issues_count":4,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-12-22T20:20:48.971Z","etag":null,"topics":["elixir","open-banking","open-finance","pluggy","pluggy-sdk"],"latest_commit_sha":null,"homepage":"","language":"Elixir","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Finbits.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-04-24T17:34:23.000Z","updated_at":"2023-01-28T03:56:52.000Z","dependencies_parsed_at":"2022-09-13T03:02:32.533Z","dependency_job_id":null,"html_url":"https://github.com/Finbits/pluggy_elixir","commit_stats":null,"previous_names":["brainnco/pluggy_elixir"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Finbits%2Fpluggy_elixir","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Finbits%2Fpluggy_elixir/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Finbits%2Fpluggy_elixir/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Finbits%2Fpluggy_elixir/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Finbits","download_url":"https://codeload.github.com/Finbits/pluggy_elixir/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":235581533,"owners_count":19013089,"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","open-banking","open-finance","pluggy","pluggy-sdk"],"created_at":"2024-09-30T15:43:49.837Z","updated_at":"2025-10-07T02:31:57.720Z","avatar_url":"https://github.com/Finbits.png","language":"Elixir","funding_links":[],"categories":[],"sub_categories":[],"readme":"# PluggyElixir\n\n[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/Finbits/pluggy_elixir/CI?style=flat-square)](https://github.com/Finbits/pluggy_elixir/actions?query=workflow%3ACI)\n[![Hex.pm](https://img.shields.io/hexpm/v/pluggy_elixir?style=flat-square)](https://hex.pm/packages/pluggy_elixir)\n[![Hex.pm](https://img.shields.io/hexpm/l/pluggy_elixir?style=flat-square)](https://hex.pm/packages/pluggy_elixir)\n[![Hex.pm](https://img.shields.io/hexpm/dt/pluggy_elixir?style=flat-square)](https://hex.pm/packages/pluggy_elixir)\n[![codecov](https://img.shields.io/codecov/c/github/Finbits/pluggy_elixir?style=flat-square)](https://codecov.io/gh/Finbits/pluggy_elixir)\n\nWelcome to Pluggy Elixir, an API client written in Elixir to access the Open Finance services provided by [Pluggy](http://pluggy.ai)\n\n## Installation\n\nAdd `pluggy_elixir` to your list of dependencies in `mix.exs`:\n\n```elixir\ndef deps do\n  [\n    {:pluggy_elixir, \"~\u003e 0.0.1\"}\n  ]\nend\n```\n\nUpdate deps\n\n```sh\nmix deps.get\n```\n\nAdd the credentials to your config file (ex: `config.exs`)\n\n```elixir\nconfig :pluggy_elixir,\n  client_id: \"your-app-client-id\",\n  client_secret: \"your-app-client-secret\",\n```\n\nSee more about configurations in `PluggyElixir.Config` docs.\n\n## Use cases\n\n### Register\n\u003ctable\u003e\n\u003ctr\u003e\n\u003cth\u003e Data \u003c/th\u003e\n\u003cth\u003e Use Cases \u003c/th\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\n\n```\n{\n  full_name,\n  tax_id,\n  date_of_bird,\n  address,\n  phone_numbers\n}\n```\n\u003c/td\u003e\n\u003ctd\u003e\n\u003cli\u003eOnboarding\u003c/li\u003e\n\u003cli\u003eRegistration\u003c/li\u003e\n\u003cli\u003eKYC\u003c/li\u003e\n\u003cli\u003eCustomer segmentation\u003c/li\u003e\n\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/table\u003e\n\n### Checking account\n\u003ctable\u003e\n\u003ctr\u003e\n\u003cth\u003e Data \u003c/th\u003e\n\u003cth\u003e Use Cases \u003c/th\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\n\n```\n{\n  balances,\n  transactions: [\n    {\n      date,\n      values,\n      description,\n      type,\n      category\n    }\n  ]\n}\n```\n\u003c/td\u003e\n\u003ctd\u003e\n\u003cli\u003eIncome analysis\u003c/li\u003e\n\u003cli\u003eConsumption profile\u003c/li\u003e\n\u003cli\u003eFinancial management\u003c/li\u003e\n\u003cli\u003eRisk modeling\u003c/li\u003e\n\u003cli\u003eFinancial monitoring\u003c/li\u003e\n\u003cli\u003eInvestment capacity\u003c/li\u003e\n\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/table\u003e\n\n### Credit card\n\u003ctable\u003e\n\u003ctr\u003e\n\u003cth\u003e Data \u003c/th\u003e\n\u003cth\u003e Use Cases \u003c/th\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\n\n```\n{\n  limits,\n  minimum_payment,\n  brand,\n  segment,\n  maturity,\n  transactions\n}\n```\n\u003c/td\u003e\n\u003ctd\u003e\n\u003cli\u003eConsumption profile\u003c/li\u003e\n\u003cli\u003eFinancial management\u003c/li\u003e\n\u003cli\u003eCredit taking capacity\u003c/li\u003e\n\u003cli\u003eFinancial monitoring\u003c/li\u003e\n\u003cli\u003eExpenses by category\u003c/li\u003e\n\u003cli\u003eConsumption cycles\u003c/li\u003e\n\u003cli\u003eRecurring expenses\u003c/li\u003e\n\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/table\u003e\n\n### Investments\n\u003ctable\u003e\n\u003ctr\u003e\n\u003cth\u003e Data \u003c/th\u003e\n\u003cth\u003e Use Cases \u003c/th\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\n\n```\n{\n  assets,\n  code,\n  type,\n  quantity,\n  value,\n  historical_profitability,\n  taxes,\n  index,\n  balance_at_the_broker,\n  handling_at_the_broker\n}\n```\n\u003c/td\u003e\n\u003ctd\u003e\n\u003cli\u003ePortfolio Consolidation\u003c/li\u003e\n\u003cli\u003eFinancial Profile\u003c/li\u003e\n\u003cli\u003eTransaction monitoring\u003c/li\u003e\n\u003cli\u003eInvestment capacity analysis\u003c/li\u003e\n\u003cli\u003ePortfolio risk analysis\u003c/li\u003e\n\u003cli\u003eInvestment automation\u003c/li\u003e\n\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/table\u003e\n\n### Plugged Institutions\n\u003ctable\u003e\n\u003ctr\u003e\n\u003cth\u003e Banks \u003c/th\u003e\n\u003cth\u003e Investment brokers \u003c/th\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\n\u003cli\u003eItaú (Personal e Corporate)\u003c/li\u003e\n\u003cli\u003eBradesco (Personal e Corporate)\u003c/li\u003e\n\u003cli\u003eNubank (Personal)\u003c/li\u003e\n\u003cli\u003eSantander (Personal e Corporate)\u003c/li\u003e\n\u003cli\u003eBanco do Brasil (Personal e Corporate)\u003c/li\u003e\n\u003cli\u003eCaixa (Personal e Corporate)\u003c/li\u003e\n\u003cli\u003eInter (Personal e Corporate)\u003c/li\u003e\n\u003cli\u003eModal Mais (Personal)\u003c/li\u003e\n\u003cli\u003eBTG Pactual (Personal)\u003c/li\u003e\n\u003cli\u003eMercado Pago (Personal)\u003c/li\u003e\n\u003c/td\u003e\n\u003ctd\u003e\n\u003cli\u003eXP Investimentos\u003c/li\u003e\n\u003cli\u003eRico\u003c/li\u003e\n\u003cli\u003eEasynvest\u003c/li\u003e\n\u003cli\u003eÓrama\u003c/li\u003e\n\u003cli\u003eGenial\u003c/li\u003e\n\u003cli\u003eAgora\u003c/li\u003e\n\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/table\u003e\n\n## API spec\n\nFor most up-to-date and accurate documentation, please see the [API Spec](https://docs.pluggy.ai) page.\n\n## Contributing\n\n[Contributing Guide](CONTRIBUTING.md)\n\n## License\n\n[Apache License, Version 2.0](LICENSE) © [Finbits](https://github.com/Finbits)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffinbits%2Fpluggy_elixir","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffinbits%2Fpluggy_elixir","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffinbits%2Fpluggy_elixir/lists"}