/coin-app-server-api

Coins App API is a RESTful web service that provides access to a collection of coins of different countries. The API allows developers to retrieve coin data using GET requests with various search queries.

Primary LanguageJavaScript

Overview

Coins App API is a RESTful web service that provides access to a collection of coins of different countries. The API allows developers to retrieve coin data using GET requests with various search queries.

Tools

NPM NodeJS Nodemon Express.js JavaScript MySQL

  • npm
  • node js
  • express JS
  • mysql
  • nodemon
  • cors
  • dotenv
  • body-parser

Usage

To use this API application, you will need to have Node.js and npm installed on your machine. Once you have those installed, you can run the following commands to get started:

Send all data requests to:

https://coin-app-server-api.vercel.app/api/

API Endpoints

GET "/api/search"

The endpoint allows users to retrieve list of coins. To retrieve the list of coins.

GET "/api/description/:id"

The endpoint allows users to retrieve a specific coin information by ID.

Parameters for search

  • q (optional) search by coin name
  • c (optional) country
  • t (optional) type of coin
  • m (optional) metal of coin
  • qt (optional) quality of coin
  • pFrom & pTo (otional) price range
  • yFrom & yTo (otional) year range

Example request:

https://coin-app-server-api.vercel.app/api/search?c=canada&yTo=1980

Development setup

npm install
nodemon server

Meta

Nijat Gurbanov

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b feature/fooBar)
  3. Commit your changes (git commit -am 'Add some fooBar')
  4. Push to the branch (git push origin feature/fooBar)
  5. Create a new Pull Request