Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nef10/wealthsimpledownloader
Swift library to download data from Wealthsimple using the API
https://github.com/nef10/wealthsimpledownloader
api-wrapper wealthsimple
Last synced: 12 days ago
JSON representation
Swift library to download data from Wealthsimple using the API
- Host: GitHub
- URL: https://github.com/nef10/wealthsimpledownloader
- Owner: Nef10
- License: mit
- Created: 2020-07-14T07:00:47.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-07-13T21:53:13.000Z (4 months ago)
- Last Synced: 2024-10-10T13:28:38.621Z (29 days ago)
- Topics: api-wrapper, wealthsimple
- Language: Swift
- Homepage: https://nef10.github.io/WealthsimpleDownloader/
- Size: 1.58 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# WealthsimpleDownloader
[](https://github.com/Nef10/WealthsimpleDownloader/actions?query=workflow%3A%22CI%22) [](https://nef10.github.io/WealthsimpleDownloader/) [](https://github.com/Nef10/WealthsimpleDownloader/blob/main/LICENSE) [](https://github.com/Nef10/WealthsimpleDownloader/releases)  
## What
This is a small library to download data from Wealthsimple. It does not support Wealthsimple Trade and currently only supports downloading accounts, positions and transactions. The documentation of the Wealthsimple API I am using can be found at https://developers.wealthsimple.com/. To authenticate I am using the same client id as their web site, which uses the same API as backend.
## How
1) Implement a `CredentialStore`
Example using the KeychainAccess library
```swift
import KeychainAccess
class KeyChainCredentialStorage: CredentialStorage {
let keychain = Keychain(service: "XYZ")
func save(_ value: String, for key: String) {
keychain[key] = value
}
func read(_ key: String) -> String? {
keychain[key]
}
}
```
2) Implement an `AuthenticationCallback` which will ask the user for their username, password and one time password.
3) Initialize `WealthsimpleDownloader` with your two implementations: `let wealthsimpleDownloader = WealthsimpleDownloader(authenticationCallback: myAuthenticationCallback, credentialStorage: myCredentialStorage)`
4) Call `wealthsimpleDownloader.authenticate() { }` and wait for the callback
5) Now you can start retreiving data with the other methods provided on `WealthsimpleDownloader` like `getAccounts` or `getPositions`
Please check out the complete documentation [here](https://nef10.github.io/WealthsimpleDownloader/). You can also have a look at the [SwiftBeanCountImporterApp](https://github.com/Nef10/SwiftBeanCountImporterApp) which uses this library. If you want to convert the downloaded data into Beancount format, also check out [SwiftBeanCountWealthsimpleMapper](https://github.com/Nef10/SwiftBeanCountWealthsimpleMapper)
## Usage
The library supports the Swift Package Manger, so simply add a dependency in your `Package.swift`:
```
.package(url: "https://github.com/Nef10/WealthsimpleDownloader.git", .upToNextMajor(from: "X.Y.Z")),
```
## Limitations
Please note that I developed this library for my own needs and there may be bugs. It currently only accesses a very limited scope of the API. Even for the endpoints it implements, there are further limitations:
* Paging is not supported
* Only works on Accounts with 2FA enabled
Pull requests to extend the scope or remove limitations are very welcome.
## Copyright
While my code is licensed under the [MIT License](https://github.com/Nef10/WealthsimpleDownloader/blob/main/LICENSE), the source repository may include names or other trademarks of Wealthsimple or other entities; potential usage restrictions for these elements still apply and are not touched by the software license. Same applies for the API design. I am in no way affilliated with Wealthsimple other than beeing customer.