PluggyDocs

Quick Start

Get up and running with Pluggy in minutes.

Get your first connection running with Pluggy in a few minutes. With a single API, Pluggy brings your users' financial data so you can build unique products for your customers.

Start even faster

Check out our quickstart repository on GitHub -- it contains ready-to-run sample apps (Node, Python, Java, and frontend examples) that implement this entire flow.

1. Create your account and application#

  1. Sign up at the Pluggy Dashboard.
  2. Create an application. Every application has its own CLIENT_ID and CLIENT_SECRET -- you'll find them on the application's page in the Dashboard.

New applications start with access to our Sandbox connectors, so you can test the whole flow with fake institutions before going to production.

2. Get an API Key#

Authenticate with your credentials to get an API Key. This step must be done from your server -- never expose your CLIENT_SECRET in client-side code.

curl -X POST https://api.pluggy.ai/auth \
  -H "Content-Type: application/json" \
  -d '{
    "clientId": "YOUR_CLIENT_ID",
    "clientSecret": "YOUR_CLIENT_SECRET"
  }'

The response contains an apiKey, valid for 2 hours, with full access to the API:

{
  "apiKey": "eyJhbGciOiJIUzI1..."
}

3. Create a Connect Token#

To let your users connect their accounts from your app, create a short-lived Connect Token (valid for 30 minutes) with your API Key:

curl -X POST https://api.pluggy.ai/connect_token \
  -H "Content-Type: application/json" \
  -H "X-API-KEY: YOUR_API_KEY" \
  -d '{}'

The response contains an accessToken -- this is the token you pass to the widget. See Authentication for the full details on scopes and options.

4. Open the Connect Widget#

Use the Connect Widget in your frontend, initialized with the accessToken from the previous step. The widget handles the entire authentication flow with the financial institution and creates an Item -- the representation of the user's connection. Grab the itemId from the widget's onSuccess event.

5. Fetch the data#

With the connection created, use your API Key (server-side) to retrieve the data:

# List the accounts of the connection
curl "https://api.pluggy.ai/accounts?itemId=YOUR_ITEM_ID" \
  -H "X-API-KEY: YOUR_API_KEY"
 
# List the transactions of an account
curl "https://api.pluggy.ai/transactions?accountId=YOUR_ACCOUNT_ID" \
  -H "X-API-KEY: YOUR_API_KEY"

Next steps#