Skip to content
Yoxira edited this page Aug 22, 2024 · 17 revisions

Installation

API Documentation

Saved rates format

Configuration

Contributing

Migration from v4.0.0

Note

Those changes are NOT breaking. The result of all the endpoints remain the same, including values of _id in the getHistory endpoint.

Starting from v4.1.0, Currencyinfo uses a different internal database structure. To migrate the database from a previous version, use the migrate-db script and specify the MongoDB URL along with the name of the database you wish to migrate. For example, to migrate the database named tickersdb, you would run:

pnpm run migrate-db mongodb://localhost:27017/tickersdb

Migration from v3.x.x

If you want to update the info service from the previous version, you must install it from scratch.

You can use the migration script to help migrate the configuration file from v3. Place your old config file in the root of the app and run the following command from the root directory of the app:

pnpm run migrate ./config.json

This command will create the config.jsonc file in the same directory with the migrated properties.

Warning

Note any warnings when using the script to ensure everything works correctly.

Clone this wiki locally