An open API service indexing awesome lists of open source software.

https://github.com/2kabhishek/ticker-api

REST API used for Ticker data 💰ℹ️
https://github.com/2kabhishek/ticker-api

micronaut rest-api ticker

Last synced: about 1 month ago
JSON representation

REST API used for Ticker data 💰ℹ️

Awesome Lists containing this project

README

          

## CI/CD Kata

[![CI](https://github.com/2KAbhishek/ticker-api/actions/workflows/gradle.yml/badge.svg)](https://github.com/2KAbhishek/ticker-api/actions/workflows/gradle.yml)

### Application Details

This is a simple Micronaut application that makes requests to a REST API and returns the response.
The server is available [here](https://61deab5cfb8dae0017c2e196.mockapi.io/api/v1/stocks) which serves list of Penny Stocks.

The application is able to get stock information from this API based on a ticker name sent as a query parameter.

The source code for the application along with the test cases is available in this repository.

### Running the application

- To build the project, use `./gradlew build`
- To run all test cases, use `./gradlew test`
- To run gradle task use `./gradlew run`

### Example

```json
// curl $APP-HOST:PORT/tickers/HCC
{
"ticker": "HCC",
"name": "Hindustan Construction Company Limited",
"price": 65.0
}

// curl $APP-HOST:PORT/tickers/TATAMOTORS
{
"ticker": "TATAMOTORS",
"name": "TATA MOTORS LIMITED",
"price": 99
}
```

### Live Version

[Live Link](https://add-your-link.here)