Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/miensoap/kishelper
Features for utilizing the KIS Open API
https://github.com/miensoap/kishelper
java kis library openapi stock stock-prices
Last synced: about 1 month ago
JSON representation
Features for utilizing the KIS Open API
- Host: GitHub
- URL: https://github.com/miensoap/kishelper
- Owner: Miensoap
- License: mit
- Created: 2024-07-10T12:54:50.000Z (4 months ago)
- Default Branch: master
- Last Pushed: 2024-09-17T09:22:02.000Z (2 months ago)
- Last Synced: 2024-10-14T05:01:33.539Z (about 1 month ago)
- Topics: java, kis, library, openapi, stock, stock-prices
- Language: Java
- Homepage: https://central.sonatype.com/artifact/io.github.miensoap/KISHelper
- Size: 129 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# KISHelper
[](https://opensource.org/licenses/MIT)
KISHelper is a Java library for interacting with the Korea Investment Open API.
This library simplifies the process of accessing and using the API,
providing a more efficient way to integrate financial data into your applications.
**"This project is under ongoing development. For more details, please visit [this branch](https://github.com/Miensoap/KISHelper/tree/dev) or [this blog](https://miensoap.tistory.com/category/KISHelper)."**
## Table of Contents
- [Features](#features)
- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)
- [Contact](#contact)
## Features
- Easy integration with the Korea Investment Open API
- Simplified data retrieval
- Lightweight and efficient
## Installation
Add the following to your `build.gradle` file to include KISHelper in your project:
```groovy
repositories {
mavenCentral()
}
dependencies {
implementation 'io.github.miensoap:KISHelper:0.1.0'
}
```
Add your [KIS Open API key](https://apiportal.koreainvestment.com/intro) to `resources/kish.yml` file:
```yaml
appkey: 'your_appkey'
appsecret: 'your_secret_key'
accessToken: 'your_access_token' (optional)
```
[*How to get your accessToken*](https://apiportal.koreainvestment.com/apiservice/oauth2#L_fa778c98-f68d-451e-8fff-b1c6bfe5cd30)
## Usage
### Example
```java
// Example usage of KISHelper library
import io.github.miensoap.kishelper.core.KISClient;
import java.io.IOException;
public class Main {
public static void main(String[] args) {
KISClient client = KISClient.getInstance();
System.out.println(client.getOverseasDailyPrice("AMS", "SOXL", false).size());
// version 0.2.3
Stock soxl = new Stock("SOXL", AMEX);
System.out.println(soxl.getPriceOfDate(LocalDate.of(2024, 8, 2), true));
// version 0.2.4
System.out.println(soxl.getDetails().englishName());
}
}
```
For more detailed usage, please refer to the [documentation](https://github.com/Miensoap/KISHelper.git).
## Contributing
We welcome contributions to the KISHelper project. Please read our [Contributing Guidelines](CONTRIBUTING.md) for more information on how to get started.
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.
## Contact
Developer: Miensoap
Email: [email protected]
GitHub: [Miensoap](https://github.com/Miensoap)
## Acknowledgements
Special thanks to all the contributors who helped in making this project better.
---
Feel free to customize this README file further as per your needs.