Public
Documentation Settings
No Environment
Double Column
cURL - cURL
psgc
Introduction
GET
/api/regions
GET
/api/regions/{region}
GET
/api/provinces
GET
/api/provinces/{province}
GET
/api/districts
GET
/api/districts/{district}
GET
/api/cities
GET
/api/cities/{city}
GET
/api/municipalities
GET
/api/municipalities/{municipality}
GET
/api/sub-municipalities
GET
/api/sub-municipalities/{subMunicipality}
GET
/api/barangays
GET
/api/barangays/{barangay}

psgc

GET/api/regions

{{URL}}/api/regions
HEADERS
Accept

application/json

Example Request
/api/regions
curl
curl --location -g '{{URL}}/api/regions' \
--header 'Accept: application/json'
Example Response
No response body
This request doesn't return any response body
No response headers
This request doesn't return any response headers

GET/api/regions/{region}

{{URL}}/api/regions/070000000
HEADERS
Accept

application/json

Example Request
/api/regions/{region}
curl
curl --location -g '{{URL}}/api/regions/070000000' \
--header 'Accept: application/json'
Example Response
No response body
This request doesn't return any response body
No response headers
This request doesn't return any response headers

GET/api/provinces

{{URL}}/api/provinces
HEADERS
Accept

application/json

Example Request
/api/provinces
curl
curl --location -g '{{URL}}/api/provinces' \
--header 'Accept: application/json'
Example Response
No response body
This request doesn't return any response body
No response headers
This request doesn't return any response headers

GET/api/provinces/{province}

{{URL}}/api/provinces/072200000
HEADERS
Accept

application/json

Example Request
200 - Get specific province and its municipalities
curl
curl --location -g '{{URL}}/api/provinces/012800000?include=municipalities'
200 OK
Example Response
json
{
  "data": {
    "id": 1,
    "code": "012800000",
    "region_id": 1,
    "name": "ILOCOS NORTE",
    "income_class": "1st",
    "population": 593081,
    "created_at": "2019-12-02 03:19:39",
    "updated_at": "2019-12-02 03:19:39",
    "municipalities": [
      {
        "id": 1,
        "code": "012801000",
        "province_id": 1,
        "name": "ADAMS",
        "income_class": "5th",
        "population": 1792,
        "created_at": "2019-12-02 03:19:39",
        "updated_at": "2019-12-02 03:19:39"
      },
      {
        "id": 2,
        "code": "012802000",
        "province_id": 1,
        "name": "BACARRA",
        "income_class": "3rd",
        "population": 32215,
        "created_at": "2019-12-02 03:19:39",
        "updated_at": "2019-12-02 03:19:39"
      },
      {
        "id": 3,
        "code": "012803000",
        "province_id": 1,
        "name": "BADOC",
        "income_class": "3rd",
        "population": 31616,
        "created_at": "2019-12-02 03:19:40",
        "updated_at": "2019-12-02 03:19:40"
      },
      {
        "id": 4,
        "code": "012804000",
        "province_id": 1,
        "name": "BANGUI",
        "income_class": "4th",
        "population": 14672,
        "created_at": "2019-12-02 03:19:40",
        "updated_at": "2019-12-02 03:19:40"
      },
      {
        "id": 5,
        "code": "012806000",
        "province_id": 1,
        "name": "BURGOS",
        "income_class": "5th",
        "population": 9777,
        "created_at": "2019-12-02 03:19:40",
        "updated_at": "2019-12-02 03:19:40"
      },
      {
        "id": 6,
        "code": "012807000",
        "province_id": 1,
        "name": "CARASI",
        "income_class": "5th",
        "population": 1567,
        "created_at": "2019-12-02 03:19:40",
        "updated_at": "2019-12-02 03:19:40"
      },
      {
        "id": 7,
        "code": "012808000",
        "province_id": 1,
        "name": "CURRIMAO",
        "income_class": "4th",
        "population": 12184,
        "created_at": "2019-12-02 03:19:40",
        "updated_at": "2019-12-02 03:19:40"
      },
      {
        "id": 8,
        "code": "012809000",
        "province_id": 1,
        "name": "DINGRAS",
        "income_class": "2nd",
        "population": 38562,
        "created_at": "2019-12-02 03:19:40",
        "updated_at": "2019-12-02 03:19:40"
      },
      {
        "id": 9,
        "code": "012810000",
        "province_id": 1,
        "name": "DUMALNEG",
        "income_class": "5th",
        "population": 2947,
        "created_at": "2019-12-02 03:19:40",
        "updated_at": "2019-12-02 03:19:40"
      },
      {
        "id": 10,
        "code": "012811000",
        "province_id": 1,
        "name": "BANNA (ESPIRITU)",
        "income_class": "4th",
        "population": 19438,
        "created_at": "2019-12-02 03:19:40",
        "updated_at": "2019-12-02 03:19:40"
      },
      {
        "id": 11,
        "code": "012813000",
        "province_id": 1,
        "name": "MARCOS",
        "income_class": "4th",
        "population": 17777,
        "created_at": "2019-12-02 03:19:41",
        "updated_at": "2019-12-02 03:19:41"
      },
      {
        "id": 12,
        "code": "012814000",
        "province_id": 1,
        "name": "NUEVA ERA",
        "income_class": "3rd",
        "population": 9506,
        "created_at": "2019-12-02 03:19:41",
        "updated_at": "2019-12-02 03:19:41"
      },
      {
        "id": 13,
        "code": "012815000",
        "province_id": 1,
        "name": "PAGUDPUD",
        "income_class": "4th",
        "population": 23770,
        "created_at": "2019-12-02 03:19:41",
        "updated_at": "2019-12-02 03:19:41"
      },
      {
        "id": 14,
        "code": "012816000",
        "province_id": 1,
        "name": "PAOAY",
        "income_class": "4th",
        "population": 24866,
        "created_at": "2019-12-02 03:19:41",
        "updated_at": "2019-12-02 03:19:41"
      },
      {
        "id": 15,
        "code": "012817000",
        "province_id": 1,
        "name": "PASUQUIN",
        "income_class": "3rd",
        "population": 28980,
        "created_at": "2019-12-02 03:19:42",
        "updated_at": "2019-12-02 03:19:42"
      },
      {
        "id": 16,
        "code": "012818000",
        "province_id": 1,
        "name": "PIDDIG",
        "income_class": "3rd",
        "population": 21497,
        "created_at": "2019-12-02 03:19:42",
        "updated_at": "2019-12-02 03:19:42"
      },
      {
        "id": 17,
        "code": "012819000",
        "province_id": 1,
        "name": "PINILI",
        "income_class": "3rd",
        "population": 17300,
        "created_at": "2019-12-02 03:19:42",
        "updated_at": "2019-12-02 03:19:42"
      },
      {
        "id": 18,
        "code": "012820000",
        "province_id": 1,
        "name": "SAN NICOLAS",
        "income_class": "2nd",
        "population": 36736,
        "created_at": "2019-12-02 03:19:42",
        "updated_at": "2019-12-02 03:19:42"
      },
      {
        "id": 19,
        "code": "012821000",
        "province_id": 1,
        "name": "SARRAT",
        "income_class": "4th",
        "population": 25212,
        "created_at": "2019-12-02 03:19:42",
        "updated_at": "2019-12-02 03:19:42"
      },
      {
        "id": 20,
        "code": "012822000",
        "province_id": 1,
        "name": "SOLSONA",
        "income_class": "3rd",
        "population": 24121,
        "created_at": "2019-12-02 03:19:42",
        "updated_at": "2019-12-02 03:19:42"
      },
      {
        "id": 21,
        "code": "012823000",
        "province_id": 1,
        "name": "VINTAR",
        "income_class": "1st",
        "population": 32220,
        "created_at": "2019-12-02 03:19:43",
        "updated_at": "2019-12-02 03:19:43"
      }
    ]
  }
}
Server

nginx/1.17.3

Content-Type

application/json

Transfer-Encoding

chunked

Connection

keep-alive

X-Powered-By

PHP/7.3.12

Cache-Control

no-cache, private

Date

Tue, 03 Dec 2019 04:03:39 GMT

X-RateLimit-Limit

60

X-RateLimit-Remaining

58

Access-Control-Allow-Origin

*

GET/api/districts

{{URL}}/api/districts
HEADERS
Accept

application/json

Example Request
/api/districts
curl
curl --location -g '{{URL}}/api/districts' \
--header 'Accept: application/json'
Example Response
No response body
This request doesn't return any response body
No response headers
This request doesn't return any response headers