openapi: 3.1.0
info:
  title: Country State City Cities Countries API
  description: The Country State City API exposes a global geographical reference dataset of 247+ countries, 5,000+ states / provinces, and 150,000+ cities with ISO codes, phone codes, currencies, native names, regions, sub-regions, coordinates, time zones, and flag emoji. Endpoints are read-only JSON REST resources authenticated with the X-CSCAPI-KEY header.
  version: '1.0'
  contact:
    name: Country State City API
    url: https://docs.countrystatecity.in/
servers:
- url: https://api.countrystatecity.in/v1
  description: Country State City API production
security:
- ApiKeyAuth: []
tags:
- name: Countries
  description: Country reference data including ISO codes, currencies, phone codes, and regions.
paths:
  /countries:
    get:
      operationId: listCountries
      summary: List all countries
      description: Returns the full list of countries with ISO2 / ISO3 codes, phone codes, capitals, native names, regions, currencies, and flag emoji.
      tags:
      - Countries
      responses:
        '200':
          description: A list of country resources.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Country'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /countries/{ciso}:
    get:
      operationId: getCountry
      summary: Get a country by ISO2 code
      tags:
      - Countries
      parameters:
      - name: ciso
        in: path
        required: true
        description: ISO 3166-1 alpha-2 country code.
        schema:
          type: string
          minLength: 2
          maxLength: 2
      responses:
        '200':
          description: A single country resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Country'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  responses:
    Unauthorized:
      description: Missing or invalid X-CSCAPI-KEY.
    NotFound:
      description: Resource not found.
  schemas:
    Country:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
        iso2:
          type: string
        iso3:
          type: string
        phonecode:
          type: string
        capital:
          type: string
        currency:
          type: string
        native:
          type: string
        emoji:
          type: string
        region:
          type: string
        subregion:
          type: string
        latitude:
          type: string
        longitude:
          type: string
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-CSCAPI-KEY
externalDocs:
  description: Country State City API Documentation
  url: https://docs.countrystatecity.in/api/introduction