Code Monkey home page Code Monkey logo

country-api's Introduction

Free Country API

Welcome to the Free Country API! This API provides information about various countries, including details like country names and country codes.

Table of Contents

Introduction

This API is designed to offer free access to country-related data, allowing developers to retrieve information about different countries.

Getting Started

Installation

To use this API, follow these steps:

  1. Clone the repository: git clone https://github.com/Fadilix/country-api.git
  2. Install dependencies: npm install
  3. Start the server: npm start

Usage

Make requests to the specified endpoints to retrieve information about countries.

Endpoints

Get All Countries

  • URL: /api/countries
  • Method: GET
  • Description: Retrieve a list of all countries.
  • Example response:
{
  "data": [
    {
      "name": "Afghanistan",
      "code": "AF"
    },
    {
      "name": "Åland Islands",
      "code": "AX"
    },
    {
      "name": "Albania",
      "code": "AL"
    }
    // other countries...
  ]
}

Get Country by Name

  • URL: /api/countries/:countryName
  • Method: GET
  • Description: Retrieve information about a specific country by its name.
  • Example response:
{
  "data": [
    {
      "name": "Canada",
      "code": "CA"
    }
  ]
}

Get Country by Code

  • URL: /api/countries/code/:countryCode
  • Method: GET
  • Description: Retrieve information about a specific country by its country code.
  • Example response:
{
  "data": [
    {
      "name": "Albania",
      "code": "AL"
    }
  ]
}

country-api's People

Contributors

fadilix avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.