{"id":20405751,"url":"https://github.com/cloudquery/cq-source-plaid","last_synced_at":"2025-05-08T13:31:12.836Z","repository":{"id":65661825,"uuid":"592329199","full_name":"cloudquery/cq-source-plaid","owner":"cloudquery","description":"A CloudQuery source plugin for [Plaid](https://plaid.com/)","archived":false,"fork":false,"pushed_at":"2024-06-14T14:46:14.000Z","size":609,"stargazers_count":2,"open_issues_count":0,"forks_count":1,"subscribers_count":4,"default_branch":"main","last_synced_at":"2024-06-20T12:08:10.478Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cloudquery.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":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-01-23T13:55:27.000Z","updated_at":"2024-06-14T14:46:08.000Z","dependencies_parsed_at":"2024-06-14T16:11:05.341Z","dependency_job_id":null,"html_url":"https://github.com/cloudquery/cq-source-plaid","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudquery%2Fcq-source-plaid","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudquery%2Fcq-source-plaid/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudquery%2Fcq-source-plaid/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudquery%2Fcq-source-plaid/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cloudquery","download_url":"https://codeload.github.com/cloudquery/cq-source-plaid/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224732033,"owners_count":17360417,"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":[],"created_at":"2024-11-15T05:12:53.991Z","updated_at":"2025-05-08T13:31:12.825Z","avatar_url":"https://github.com/cloudquery.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# CloudQuery Plaid Source Plugin\n\n# DEPRECATED - FOR THE LATEST VERSION OF THIS PLUGIN PLEASE VISIT https://hub.cloudquery.io/plugins/source/cloudquery/plaid/latest/docs\n\n[![test](https://github.com/cloudquery/cq-source-plaid/actions/workflows/test.yml/badge.svg)](https://github.com/cloudquery/cq-source-plaid/actions/workflows/test.yml)\n[![Go Report Card](https://goreportcard.com/badge/github.com/cloudquery/cq-source-plaid)](https://goreportcard.com/report/github.com/cloudquery/cq-source-plaid)\n\nA [Plaid](https://plaid.com/) source plugin for CloudQuery that loads data from the [Plaid API](https://plaid.com/docs/api/) to any database, data warehouse or data lake supported by [CloudQuery](https://www.cloudquery.io/docs/quickstart), such as PostgreSQL, BigQuery, Athena, and many more.\n\n## Supported Resources\n\nFor a full list of supported resources, see [the tables documentation](./docs/tables/README.md).\n\n## Configuration\n\nThe following source configuration file will sync [supported data points](./docs/tables/README.md) to a PostgreSQL database. See [the CloudQuery Quickstart](https://www.cloudquery.io/docs/quickstart) for more information on how to configure the source and destination.\n\n```yaml\nkind: source\nspec:\n  name: \"plaid\"\n  path: \"cloudquery/plaid\"\n  version: \"v1.1.0\"\n  destinations: [postgresql]\n  spec:\n    # plugin spec section\n    client_id: ${PLAID_CLIENT_ID}\n    secret: ${PLAID_SECRET}\n    access_token: ${PLAID_ACCESS_TOKEN}\n    environment: sandbox\n```\n\n### Plugin Spec\n\n- `client_id` (string, required):\n\n  A Plaid client ID from your [dashboard](https://dashboard.plaid.com/team/keys). See [the Plaid docs](https://plaid.com/docs/quickstart/#introduction) for more information\n\n- `secret` (string, required):\n\n  A Plaid secret from your [dashboard](https://dashboard.plaid.com/team/keys). See [the Plaid docs](https://plaid.com/docs/quickstart/#introduction) for more information\n\n- `access_token` (string, required):\n\n  A Plaid access token obtained by following the link authorization flow. We provide an [example application](./token-generator/README.md) to generate a token for testing purposes only.\n  For production usage you should set up a hosted frontend application and backend server that saves access tokens from link authentication flows initiated by your users.\n  See [the Plaid docs](https://plaid.com/docs/link/) for more information\n\n- `environment` (string, optional):\n\n  The Plaid environment to use. Defaults to `sandbox`. See [the Plaid docs](https://plaid.com/docs/api/#api-host) for more information. Should match the Plaid secret you are using\n\n## Example Queries\n\n### List recent transactions\n\n```sql\nselect name, category, amount, iso_currency_code, date, merchant_name, payment_channel from plaid_transactions\norder by\n  date desc\nlimit\n  10\n```\n\nExample result:\n\n```text\n                 name                  |                   category                   | amount | iso_currency_code |    date    |   merchant_name   | payment_channel \n---------------------------------------+----------------------------------------------+--------+-------------------+------------+-------------------+-----------------\n Uber 063015 SF**POOL**                | {Travel,Taxi}                                |    5.4 | \"USD\"             | 2023-01-30 | \"Uber\"            | online\n CREDIT CARD 3333 PAYMENT *//          | {Payment,\"Credit Card\"}                      |     25 | \"USD\"             | 2023-01-30 | null              | other\n ACH Electronic CreditGUSTO PAY 123456 | {Transfer,Debit}                             |   5850 | \"USD\"             | 2023-01-29 | null              | online\n CD DEPOSIT .INITIAL.                  | {Transfer,Deposit}                           |   1000 | \"USD\"             | 2023-01-29 | null              | other\n United Airlines                       | {Travel,\"Airlines and Aviation Services\"}    |   -500 | \"USD\"             | 2023-01-28 | \"United Airlines\" | in store\n Touchstone Climbing                   | {Recreation,\"Gyms and Fitness Centers\"}      |   78.5 | \"USD\"             | 2023-01-28 | null              | in store\n Starbucks                             | {\"Food and Drink\",Restaurants,\"Coffee Shop\"} |   4.33 | \"USD\"             | 2023-01-27 | \"Starbucks\"       | in store\n McDonald's                            | {\"Food and Drink\",Restaurants,\"Fast Food\"}   |     12 | \"USD\"             | 2023-01-27 | \"McDonald's\"      | in store\n SparkFun                              | {\"Food and Drink\",Restaurants}               |   89.4 | \"USD\"             | 2023-01-26 | null              | in store\n INTRST PYMNT                          | {Transfer,Credit}                            |  -4.22 | \"USD\"             | 2023-01-25 | null              | other\n(10 rows)\n```\n\n## Development\n\n### Run tests\n\n```bash\nmake test\n```\n\n### Run linter\n\n```bash\nmake lint\n```\n\n### Generate docs\n\n```bash\nmake gen-docs\n```\n### Release a new version\n\n1. Run `git tag v1.0.0` to create a new tag for the release (replace `v1.0.0` with the new version number)\n2. Run `git push origin v1.0.0` to push the tag to GitHub  \n\nOnce the tag is pushed, a new GitHub Actions workflow will be triggered to build the release binaries and create the new release on GitHub.\nTo customize the release notes, see the Go releaser [changelog configuration docs](https://goreleaser.com/customization/changelog/#changelog).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcloudquery%2Fcq-source-plaid","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcloudquery%2Fcq-source-plaid","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcloudquery%2Fcq-source-plaid/lists"}