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 month 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 (about 3 years ago)
• Default Branch: master
• Last Pushed: 2021-10-14T13:51:34.000Z (about 3 years ago)
• Last Synced: 2024-10-01T06:22:50.574Z (about 1 month 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: 2
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# spring-boot-starter-upbit

![GitHub release (latest by date)](https://img.shields.io/github/v/release/jongmin92/spring-boot-starter-upbit)

[![build](https://github.com/jongmin92/spring-boot-starter-upbit/actions/workflows/build.yml/badge.svg?branch=master&event=push)](https://github.com/jongmin92/spring-boot-starter-upbit/actions/workflows/build.yml)

![GitHub](https://img.shields.io/github/license/jongmin92/spring-boot-starter-upbit)

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)