GOgorest
Reference

List countries

get/countries

Request

  • Base URL
    https://gorest.co.in/public/v3
  • URL
    https://gorest.co.in/public/v3/countries
  • Auth
    none required

Query parameters

page[size]integer

Items on one page.

page[after]string

The cursor of the next page, from meta.next_cursor or the Link header. Treat it as opaque; it works only with the same query.

page[number]integer

Offset paging, 1 based, at most 10,000. Cannot be sent with page[after]. Pages can shift while you write.

page[count]boolean

true adds meta.total to a cursor page (it costs a count).

searchstring

Case-insensitive text search over the resource's text fields.

currency_codestring
regionstring

filter[region]=Asia,Europe (any of the UN M49 continents), filter[currency_code]=INR (either case). search matches the codes and the name.

sort'name' | '-name' | 'code' | '-code'

One field; a leading - sorts descending. Default name.

countriesstring

fields[countries]=name,currency_code returns only those fields; code is always there.

include'currency'

currency adds the currency of each item.

Headers

If-None-Matchstring

An ETag from an earlier answer; an unchanged item answers 304 with no body.

Response

One page of countries.

Example response

{
  "data": [
    {
      "alpha3": "IND",
      "calling_code": "+91",
      "code": "IN",
      "currency": {
        "code": "INR",
        "minor_unit": 2,
        "name": "Indian Rupee",
        "symbol": "₹"
      },
      "currency_code": "INR",
      "name": "India",
      "numeric_code": "356"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.