https://github.com/shoriwe/tulip

Extensible market data REST API, cache and Dashboard
https://github.com/shoriwe/tulip

apache-echarts cache finnhub go golang stock-market svelte sveltekit yahoo-finance

Last synced: 7 months ago
JSON representation

Extensible market data REST API, cache and Dashboard

• Host: GitHub
• URL: https://github.com/shoriwe/tulip
• Owner: shoriwe
• License: mit
• Created: 2022-12-30T02:22:13.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2023-02-04T16:31:03.000Z (over 2 years ago)
• Last Synced: 2025-02-12T17:32:59.504Z (9 months ago)
• Topics: apache-echarts, cache, finnhub, go, golang, stock-market, svelte, sveltekit, yahoo-finance
• Language: HTML
• Homepage:
• Size: 5.57 MB
• Stars: 2
• Watchers: 1
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# tulip

[![Build](https://github.com/shoriwe/tulip/actions/workflows/build.yaml/badge.svg)](https://github.com/shoriwe/tulip/actions/workflows/build.yaml)

[![codecov](https://codecov.io/gh/shoriwe/tulip/branch/main/graph/badge.svg?token=3XP6AV109Z)](https://codecov.io/gh/shoriwe/tulip)

![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/shoriwe/tulip)

[![Go Report Card](https://goreportcard.com/badge/github.com/shoriwe/tulip)](https://goreportcard.com/report/github.com/shoriwe/tulip)



    



Extensible market data REST API, made with the intention to interact with multiple market data sources but using the same interface for all.


## Running with Yahoo finance as data source

```shell

tulip yahoo

```

## Dashboard preview

![image-20230112102648846](docs/assets/image-20230112102648846.png)

## Components preview

| ![recommendation-trends](docs/assets/image-20230109133611842.png) | ![Peers](docs/assets/image-20230107193602052.png)   |

| ------------------------------------------------------------ | --------------------------------------------------- |

| ![Candles](docs/assets/image-20230107210247207.png)          | ![heatmap](docs/assets/image-20230109203313081.png) |

## Extending tulip

To extend tulip you can write your own `Source` interface implementations, querying for the necessary data sources you need, such as Yahoo finance API...

## Documentation

| Documentation     | URL                                                          |

| ----------------- | ------------------------------------------------------------ |

| Components        | [docs/Components.md](docs/Components.md)                     |

| OpenAPI           | [docs/api.openapi.yaml](docs/api.openapi.yaml)               |

| Library           | [https://pkg.go.dev/github.com/shoriwe/tulip](https://pkg.go.dev/github.com/shoriwe/tulip) |

| CLI               | [docs/CLI.md](docs/CLI.md)                                   |

| JavaScript client | **Coming soon...**                                           |

## REST API Clients

Coming soon...

## Binaries

You will find pre-build binaries at the [release](https://github.com/shoriwe/tulip/releases) section. If none of these binaries targets your platform use [Go command](#Go-command)

## Docker image

```shell

docker pull ghcr.io/shoriwe/tulip:latest

```

## Building from source

### Go command

```shell

go install github.com/shoriwe/tulip@latest

```

### Local build

```shell

git clone https://github.com/shoriwe/tulip

cd tulip

mkdir -p bin && go build -o bin/ .

```

### Docker image

```shell

git clone https://github.com/shoriwe/tulip

cd tulip

docker build -t tulip .

```

## Contributing

Consider giving this repository a star if it was useful to you.

- Contributions are always welcome check [CONTRIBUTING.md](CONTRIBUTING.md) for more information.

- If you have any new idea you can open an Issue and I will try my best to make it available in the project.

- If you have code ready to merge please create a PR.

## Coverage