github-starred/actual
2
0
Fork 0
mirror of https://github.com/actualbudget/actual.git synced 2026-03-11 12:43:09 -05:00
Code Issues 250 Packages Projects Releases 53 Wiki Activity

Updates per latest changes

Browse Source
This commit is contained in:
Jed Fox
2023-01-14 17:01:42 -05:00
parent 13b09bfa9f
commit 26fa00e3be
1 changed files with 7 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/Developers/using-the-API.md
View File

@@ -32,6 +32,8 @@ Next, you’ll need connect to your running server version of Actual to access y
let api = require('@actual-app/api');
await api.init({
// Budget data will be cached locally here, in subdirectories for each file.
dataDir: '/some/path',
// This is the URL of your running server
serverUrl: 'http://localhost:5006',
// This is the password you use to log into the server
@@ -91,11 +93,13 @@ These are the public methods that you can use. The API also exports low-level fu
#### `init`
<Method name="init" argsObject={true} args={[{ properties: [{ name: 'dataDir', type: 'string' }, { name: 'serverURL', type: 'string' }]}]} returns="Promise<void>" />
<Method name="init" argsObject={true} args={[{ properties: [{ name: 'dataDir', type: 'string' }, { name: 'serverURL', type: 'string' }, { name: 'password', type: 'string' }]}]} returns="Promise<void>" />
Call this before attempting to use any of the API methods. This will connect to the server and load the budget data.
Call this before attempting to use any of the API methods. This will connect to the server using the provided password and load the budget data.
`dataDir` defaults to the current working directory. If no `serverURL` is provided, no network connections will be made. If you provide a `serverURL`, the API will attempt to connect to the server and load the budget data from there.
`dataDir` defaults to the current working directory.
If no `serverURL` is provided, no network connections will be made, and you’ll only be able to access budget files already downloaded locally.
You can find your budget id in the "Advanced" section of the settings page.