Configuration Reference
ynab-connect configuration
Top-Level Configuration
The configuration file is a YAML file with the following top-level properties:
| Property | Type | Required | Description |
|---|---|---|---|
ynab | Object | Yes | YNAB API configuration |
browser | Object | No | Browser automation configuration (optional) |
server | Object | No | 2FA server configuration (optional) |
accounts | Array | Yes | List of accounts to sync |
Ynab Configuration
YNAB API configuration
| Property | Type | Required | Description |
|---|---|---|---|
accessToken | String | Yes | Your YNAB personal access token |
budgetId | String | Yes | The ID of your YNAB budget |
See the Create YNAB Token guide for instructions on obtaining these values.
Browser Configuration
Browser automation configuration (optional)
| Property | Type | Required | Description |
|---|---|---|---|
endpoint | String | Yes | URL of a browserless endpoint for headless browser automation |
See the Browser documentation for more information.
Server Configuration
2FA server configuration (optional)
| Property | Type | Required | Description |
|---|---|---|---|
port | Integer | Yes | Port number for the 2FA server |
Accounts Configuration
List of accounts to sync
Common Account Fields
All account types share these fields:
| Property | Type | Required | Description |
|---|---|---|---|
name | String | Yes | Unique name for this account |
ynabAccountId | String | Yes | The ID of the YNAB account to sync to |
interval | String | Yes | Cron expression for sync schedule (e.g., '0 2 * * *' for daily at 2 AM) |
Account Types
Trading212
Type: trading212
| Property | Type | Required | Description |
|---|---|---|---|
type | "trading212" | Yes | Connector type |
trading212ApiKey | String | Yes | Your Trading 212 API key |
trading212SecretKey | String | Yes | Your Trading 212 API secret |
See the Trading212 connector documentation for setup instructions.
Uk Student Loan
Type: uk_student_loan
| Property | Type | Required | Description |
|---|---|---|---|
type | "uk_student_loan" | Yes | Connector type |
email | Yes | Email address for login | |
password | String | Yes | Password for login |
secretAnswer | String | Yes | Secret answer for security question |
See the Uk Student Loan connector documentation for setup instructions.
Standard Life Pension
Type: standard_life_pension
| Property | Type | Required | Description |
|---|---|---|---|
type | "standard_life_pension" | Yes | Connector type |
username | String | Yes | Username for login |
password | String | Yes | Password for login |
policyNumber | String | Yes | Policy number for the pension account |
See the Standard Life Pension connector documentation for setup instructions.
Ig Trading
Type: ig_trading
| Property | Type | Required | Description |
|---|---|---|---|
type | "ig_trading" | Yes | Connector type |
igUsername | String | Yes | Username for IG login |
igPassword | String | Yes | Password for IG login |
igApiKey | String | Yes | Your IG API key |
igAccountId | String | Yes | The ID of the IG account to query |
See the Ig Trading connector documentation for setup instructions.
Notes
- You can configure multiple accounts of the same type
- The
intervalfield uses cron syntax. Use crontab.guru to help create cron expressions - Make sure each account has a unique
name - The configuration file should be placed at
/config.yamlin production, or in the project root for development