Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cloudquery/cq-source-plaid
A CloudQuery source plugin for [Plaid](https://plaid.com/)
https://github.com/cloudquery/cq-source-plaid
Last synced: about 2 months ago
JSON representation
A CloudQuery source plugin for [Plaid](https://plaid.com/)
- Host: GitHub
- URL: https://github.com/cloudquery/cq-source-plaid
- Owner: cloudquery
- License: mpl-2.0
- Created: 2023-01-23T13:55:27.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-06-14T14:46:14.000Z (7 months ago)
- Last Synced: 2024-06-20T12:08:10.478Z (7 months ago)
- Language: Go
- Size: 595 KB
- Stars: 2
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# CloudQuery Plaid Source Plugin
[](https://github.com/cloudquery/cq-source-plaid/actions/workflows/test.yml)
[](https://goreportcard.com/report/github.com/cloudquery/cq-source-plaid)
A [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.
## Supported Resources
For a full list of supported resources, see [the tables documentation](./docs/tables/README.md).
## Configuration
The 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.
```yaml
kind: source
spec:
name: "plaid"
path: "cloudquery/plaid"
version: "v1.1.0"
destinations: [postgresql]
spec:
# plugin spec section
client_id: ${PLAID_CLIENT_ID}
secret: ${PLAID_SECRET}
access_token: ${PLAID_ACCESS_TOKEN}
environment: sandbox
```
### Plugin Spec
- `client_id` (string, required):
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
- `secret` (string, required):
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
- `access_token` (string, required):
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.
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.
See [the Plaid docs](https://plaid.com/docs/link/) for more information
- `environment` (string, optional):
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
## Example Queries
### List recent transactions
```sql
select name, category, amount, iso_currency_code, date, merchant_name, payment_channel from plaid_transactions
order by
date desc
limit
10
```
Example result:
```text
name | category | amount | iso_currency_code | date | merchant_name | payment_channel
---------------------------------------+----------------------------------------------+--------+-------------------+------------+-------------------+-----------------
Uber 063015 SF**POOL** | {Travel,Taxi} | 5.4 | "USD" | 2023-01-30 | "Uber" | online
CREDIT CARD 3333 PAYMENT *// | {Payment,"Credit Card"} | 25 | "USD" | 2023-01-30 | null | other
ACH Electronic CreditGUSTO PAY 123456 | {Transfer,Debit} | 5850 | "USD" | 2023-01-29 | null | online
CD DEPOSIT .INITIAL. | {Transfer,Deposit} | 1000 | "USD" | 2023-01-29 | null | other
United Airlines | {Travel,"Airlines and Aviation Services"} | -500 | "USD" | 2023-01-28 | "United Airlines" | in store
Touchstone Climbing | {Recreation,"Gyms and Fitness Centers"} | 78.5 | "USD" | 2023-01-28 | null | in store
Starbucks | {"Food and Drink",Restaurants,"Coffee Shop"} | 4.33 | "USD" | 2023-01-27 | "Starbucks" | in store
McDonald's | {"Food and Drink",Restaurants,"Fast Food"} | 12 | "USD" | 2023-01-27 | "McDonald's" | in store
SparkFun | {"Food and Drink",Restaurants} | 89.4 | "USD" | 2023-01-26 | null | in store
INTRST PYMNT | {Transfer,Credit} | -4.22 | "USD" | 2023-01-25 | null | other
(10 rows)
```
## Development
### Run tests
```bash
make test
```
### Run linter
```bash
make lint
```
### Generate docs
```bash
make gen-docs
```
### Release a new version
1. Run `git tag v1.0.0` to create a new tag for the release (replace `v1.0.0` with the new version number)
2. Run `git push origin v1.0.0` to push the tag to GitHub
Once the tag is pushed, a new GitHub Actions workflow will be triggered to build the release binaries and create the new release on GitHub.
To customize the release notes, see the Go releaser [changelog configuration docs](https://goreleaser.com/customization/changelog/#changelog).