https://github.com/jongmin92/spring-boot-starter-upbit
Upbit(업비트) Open API Client Spring Boot Starter
https://github.com/jongmin92/spring-boot-starter-upbit
java kotlin spring-boot upbit upbit-api upbit-api-client upbit-client upbit-spring-boot-starter
Last synced: about 1 year ago
JSON representation
Upbit(업비트) Open API Client Spring Boot Starter
- Host: GitHub
- URL: https://github.com/jongmin92/spring-boot-starter-upbit
- Owner: jongmin92
- License: mit
- Created: 2021-08-19T13:35:11.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2021-10-14T13:51:34.000Z (over 4 years ago)
- Last Synced: 2025-03-26T02:03:23.012Z (about 1 year ago)
- Topics: java, kotlin, spring-boot, upbit, upbit-api, upbit-api-client, upbit-client, upbit-spring-boot-starter
- Language: Kotlin
- Homepage:
- Size: 456 KB
- Stars: 5
- Watchers: 1
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# spring-boot-starter-upbit

[](https://github.com/jongmin92/spring-boot-starter-upbit/actions/workflows/build.yml)

This is an Upbit Open API Client Spring Boot Starter based on
the [Upbit v1.2.0 reference](https://docs.upbit.com/reference).
## Download
```
repositories {
mavenCentral()
}
dependencies {
implementation("io.github.jongmin92:upbit-service-spring-boot-starter:1.0.0")
}
```
## Usage
### Set API Keys
To use it, must issue an API key from [마이페이지 - Open API 관리](https://www.upbit.com/mypage/open_api_management).
And set the issued API key on `application.yml(properties)`.
```yaml
upbit:
client:
access-key: { accessKey }
secret-key: { secretKey }
```
### Interface
This provides services for Sync, Async, and Coroutine interface.
- `UpbitExchangeService` provides functionality for the `EXCHANGE API`.
- `UpbitQuotationService` provides functionality for the `QUOTATION API`.
#### Sync
```kotlin
@Autowired
lateinit var upbitExchangeService: UpbitExchangeService
@Autowired
lateinit var upbitQuotationService: UpbitQuotationService
```
#### Async
return `CompletableFuture`
```kotlin
@Autowired
lateinit var upbitExchangeAsyncService: UpbitExchangeAsyncService
@Autowired
lateinit var upbitQuotationAsyncService: UpbitQuotationAsyncService
```
#### Coroutine
return `Deferred`
```kotlin
@Autowired
lateinit var upbitExchangeCoroutineService: UpbitExchangeCoroutineService
@Autowired
lateinit var upbitQuotationCoroutineService: UpbitQuotationCoroutineService
```
## License
[MIT](https://github.com/jongmin92/spring-boot-starter-upbit/blob/master/LICENSE)