Skip to content

Open Source Wealth Management Software. Angular + NestJS + Prisma + Nx + TypeScript 🤍

Adding Coingecko Data Provider (#1736)

Mirio80d06389220e
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 239f057e39..087480e8d2 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Added
+- Added `COINGECKO` as a new data source type
- Added the configuration to publish a `linux/arm/v7` docker image
### Fixed
diff --git a/apps/api/src/app/order/order.service.ts b/apps/api/src/app/order/order.service.ts
index 077f2227b5..2d0cb73767 100644
--- a/apps/api/src/app/order/order.service.ts
+++ b/apps/api/src/app/order/order.service.ts
@@ -110,9 +110,6 @@ export class OrderService {
dataSource,
symbol: id
};
- } else {
- data.SymbolProfile.connectOrCreate.create.symbol =
- data.SymbolProfile.connectOrCreate.create.symbol.toUpperCase();
}
await this.dataGatheringService.addJobToQueue(
diff --git a/apps/api/src/services/data-provider/coingecko/coingecko.service.ts b/apps/api/src/services/data-provider/coingecko/coingecko.service.ts
new file mode 100644
index 0000000000..7bd852f5d8
--- /dev/null
+++ b/apps/api/src/services/data-provider/coingecko/coingecko.service.ts
@@ -0,0 +1,191 @@
+import { LookupItem } from '@ghostfolio/api/app/symbol/interfaces/lookup-item.interface';
+import { ConfigurationService } from '@ghostfolio/api/services/configuration.service';
+import { DataProviderInterface } from '@ghostfolio/api/services/data-provider/interfaces/data-provider.interface';
+import {
+ IDataProviderHistoricalResponse,
+ IDataProviderResponse
+} from '@ghostfolio/api/services/interfaces/interfaces';
+import { DATE_FORMAT } from '@ghostfolio/common/helper';
+import { Granularity } from '@ghostfolio/common/types';
+import { Injectable, Logger } from '@nestjs/common';
+import {
+ AssetClass,
+ AssetSubClass,
+ DataSource,
+ SymbolProfile
+} from '@prisma/client';
+import bent from 'bent';
+import { format, fromUnixTime, getUnixTime } from 'date-fns';
+
+@Injectable()
+export class CoinGeckoService implements DataProviderInterface {
+ private baseCurrency: string;
+ private readonly URL = 'https://api.coingecko.com/api/v3';
+
+ public constructor(
+ private readonly configurationService: ConfigurationService
+ ) {
+ this.baseCurrency = this.configurationService.get('BASE_CURRENCY');
+ }
+
+ public canHandle(symbol: string) {
+ return true;
+ }
+
+ public async getAssetProfile(
+ aSymbol: string
+ ): Promise<Partial<SymbolProfile>> {
+ const response: Partial<SymbolProfile> = {
+ assetClass: AssetClass.CASH,
+ assetSubClass: AssetSubClass.CRYPTOCURRENCY,
+ currency: this.baseCurrency,
+ dataSource: this.getName(),
+ symbol: aSymbol
+ };
+
+ try {
+ const get = bent(`${this.URL}/coins/${aSymbol}`, 'GET', 'json', 200);
+ const { name } = await get();
+
+ response.name = name;
+ } catch (error) {
+ Logger.error(error, 'CoinGeckoService');
+ }
+
+ return response;
+ }
+
+ public async getDividends({
+ from,
+ granularity = 'day',
+ symbol,
+ to
+ }: {
+ from: Date;
+ granularity: Granularity;
+ symbol: string;
+ to: Date;
+ }) {
+ return {};
+ }
+
+ public async getHistorical(
+ aSymbol: string,
+ aGranularity: Granularity = 'day',
+ from: Date,
+ to: Date
+ ): Promise<{
+ [symbol: string]: { [date: string]: IDataProviderHistoricalResponse };
+ }> {
+ try {
+ const get = bent(
+ `${
+ this.URL
+ }/coins/${aSymbol}/market_chart/range?vs_currency=${this.baseCurrency.toLowerCase()}&from=${getUnixTime(
+ from
+ )}&to=${getUnixTime(to)}`,
+ 'GET',
+ 'json',
+ 200
+ );
+ const { prices } = await get();
+
+ const result: {
+ [symbol: string]: { [date: string]: IDataProviderHistoricalResponse };
+ } = {
+ [aSymbol]: {}
+ };
+
+ for (const [timestamp, marketPrice] of prices) {
+ result[aSymbol][format(fromUnixTime(timestamp / 1000), DATE_FORMAT)] = {
+ marketPrice
+ };
+ }
+
+ return result;
+ } catch (error) {
+ throw new Error(
+ `Could not get historical market data for ${aSymbol} (${this.getName()}) from ${format(
+ from,
+ DATE_FORMAT
+ )} to ${format(to, DATE_FORMAT)}: [${error.name}] ${error.message}`
+ );
+ }
+ }
+
+ public getMaxNumberOfSymbolsPerRequest() {
+ return 50;
+ }
+
+ public getName(): DataSource {
+ return DataSource.COINGECKO;
+ }
+
+ public async getQuotes(
+ aSymbols: string[]
+ ): Promise<{ [symbol: string]: IDataProviderResponse }> {
+ const results: { [symbol: string]: IDataProviderResponse } = {};
+
+ if (aSymbols.length <= 0) {
+ return {};
+ }
+
+ try {
+ const get = bent(
+ `${this.URL}/simple/price?ids=${aSymbols.join(
+ ','
+ )}&vs_currencies=${this.baseCurrency.toLowerCase()}`,
+ 'GET',
+ 'json',
+ 200
+ );
+ const response = await get();
+
+ for (const symbol in response) {
+ if (Object.prototype.hasOwnProperty.call(response, symbol)) {
+ results[symbol] = {
+ currency: this.baseCurrency,
+ dataSource: DataSource.COINGECKO,
+ marketPrice: response[symbol][this.baseCurrency.toLowerCase()],
+ marketState: 'open'
+ };
+ }
+ }
+ } catch (error) {
+ Logger.error(error, 'CoinGeckoService');
+ }
+
+ return results;
+ }
+
+ public async search(aQuery: string): Promise<{ items: LookupItem[] }> {
+ let items: LookupItem[] = [];
+
+ if (aQuery.length <= 2) {
+ return { items };
+ }
+
+ try {
+ const get = bent(
+ `${this.URL}/search?query=${aQuery}`,
+ 'GET',
+ 'json',
+ 200
+ );
+ const { coins } = await get();
+
+ items = coins.map(({ id: symbol, name }) => {
+ return {
+ name,
+ symbol,
+ currency: this.baseCurrency,
+ dataSource: this.getName()
+ };
+ });
+ } catch (error) {
+ Logger.error(error, 'CoinGeckoService');
+ }
+
+ return { items };
+ }
+}
diff --git a/apps/api/src/services/data-provider/data-provider.module.ts b/apps/api/src/services/data-provider/data-provider.module.ts
index abafe61892..d36a12aa67 100644
--- a/apps/api/src/services/data-provider/data-provider.module.ts
+++ b/apps/api/src/services/data-provider/data-provider.module.ts
@@ -1,6 +1,7 @@
import { ConfigurationModule } from '@ghostfolio/api/services/configuration.module';
import { CryptocurrencyModule } from '@ghostfolio/api/services/cryptocurrency/cryptocurrency.module';
import { AlphaVantageService } from '@ghostfolio/api/services/data-provider/alpha-vantage/alpha-vantage.service';
+import { CoinGeckoService } from '@ghostfolio/api/services/data-provider/coingecko/coingecko.service';
import { EodHistoricalDataService } from '@ghostfolio/api/services/data-provider/eod-historical-data/eod-historical-data.service';
import { GoogleSheetsService } from '@ghostfolio/api/services/data-provider/google-sheets/google-sheets.service';
import { ManualService } from '@ghostfolio/api/services/data-provider/manual/manual.service';
@@ -21,6 +22,7 @@ import { DataProviderService } from './data-provider.service';
],
providers: [
AlphaVantageService,
+ CoinGeckoService,
DataProviderService,
EodHistoricalDataService,
GoogleSheetsService,
@@ -30,6 +32,7 @@ import { DataProviderService } from './data-provider.service';
{
inject: [
AlphaVantageService,
+ CoinGeckoService,
EodHistoricalDataService,
GoogleSheetsService,
ManualService,
@@ -39,6 +42,7 @@ import { DataProviderService } from './data-provider.service';
provide: 'DataProviderInterfaces',
useFactory: (
alphaVantageService,
+ coinGeckoService,
eodHistoricalDataService,
googleSheetsService,
manualService,
@@ -46,6 +50,7 @@ import { DataProviderService } from './data-provider.service';
yahooFinanceService
) => [
alphaVantageService,
+ coinGeckoService,
eodHistoricalDataService,
googleSheetsService,
manualService,
diff --git a/prisma/migrations/20230222200407_added_coingecko_to_data_source/migration.sql b/prisma/migrations/20230222200407_added_coingecko_to_data_source/migration.sql
new file mode 100644
index 0000000000..2b40d220aa
--- /dev/null
+++ b/prisma/migrations/20230222200407_added_coingecko_to_data_source/migration.sql
@@ -0,0 +1,2 @@
+-- AlterEnum
+ALTER TYPE "DataSource" ADD VALUE 'COINGECKO';
diff --git a/prisma/schema.prisma b/prisma/schema.prisma
index 937897a1d8..dc4c1302da 100644
--- a/prisma/schema.prisma
+++ b/prisma/schema.prisma
@@ -205,6 +205,7 @@ enum AssetSubClass {
enum DataSource {
ALPHA_VANTAGE
+ COINGECKO
EOD_HISTORICAL_DATA
GOOGLE_SHEETS
MANUAL