Please wait...

Subscription Plan

Location

By: Qymera


The Location API allows users to access accurate location data in an instant. Details may include store location, addresses, or exact positioning anywhere around the world.


Overview

  • Allows users to request details with regard to specific locations such as complete address, contact details, establishment and branch name, and company ID to name a few.
  • All Location API data is available in JSON, XML, and HTML formats.
Using the API

We built the API documentation to be as self-documenting as possible, but if you find yourself overwhelmed, we organized this site into these major areas:

  • Getting Started - introduces you to the operations offered by the API.
  • API Calls - gives you a hands-on experience of those operations with an interactive console.
  • Parameters List - can be found inside each API. It lists and describes the type of information needed by the API.
  • Comments - get in touch by leaving a comment. We appreciate any feedback, too.

Getting Started

The current version of the API lives at https://gateway.qymera.tech/qymera/sb/locations/v1/.

  • https://gateway.qymera.tech/qymera/sb/locations/v1/branch/Parañaque

  • https://gateway.qymera.tech/qymera/sb/locations/v1/city/Boac

  • https://gateway.qymera.tech/qymera/sb/locations/v1/company/SSS

  • https://gateway.qymera.tech/qymera/sb/locations/v1/company/SSS/city/Kalibo

  • https://gateway.qymera.tech/qymera/sb/locations/v1/company/SSS/branch/Valencia

Endpoints
Endpoint What it does
/branch/:name Returns a list of details about the specified location including compay_id and branch name.
/city/:city Returns a list of branches within the said city.
/company/:companyName Returns a list of branches with the same company name.
/company/:companyName/city/:city Returns a list of branches with the same company name and belongs in the same city.
/company/:companyName/branch/:branchName Returns a list of branches with the same company name and in the said branch.

API Calls

Headers
Key Value Description
accept application/json
x-ibm-client-id Use the given application credential id
x-ibm-client-secret Use the given application credential secret
/branch/:name
Implementation Notes

Get data by branch name.

Parameters
Parameter Data Type Necessity Location Description
name string required query Branch name
Sample Request
curl --request GET \
  --url https://gateway.qymera.tech/qymera/sb/locations/v1/branch/REPLACE_BRANCHNAME \
  --header 'accept: application/json' \
  --header 'x-ibm-client-id: REPLACE_THIS_VALUE' \
  --header 'x-ibm-client-secret: REPLACE_THIS_VALUE'
Request

GET

https://gateway.qymera.tech/qymera/sb/locations/v1/branch/Parañaque

Response

200

{
    "message": "Success.",
    "data": [
        {
            "id": "dee7cd67-a85f-4d3b-8df3-553a7c6cd64f",
            "company_id": "3aa1bbb0-4eb5-4583-85f4-3480089ae753",
            "branch_name": "Parañaque",
            "address_line_1": "2/F Puregold Sucat, Dr. A. Santos Ave.",
            "address_line_2": "Sucat",
            "city": "Parañaque City",
            "state_or_province": "Metro Manila",
            "postal_code": "1715",
            "country": "Philippines",
            "contact_no": "(02) 825-0077, Fax No. (02) 825-0184",
            "longitude": "121.015892",
            "latitude": "14.465667",
            "created_at": "2019-09-09T11:16:27.000Z",
            "updated_at": null
        }
    ]
}

404

{
    "httpCode": "404",
    "httpMessage": "Not Found",
    "moreInformation": "No resources match requested URI"
}
/city/:city
Implementation Notes

Get data by city name.

Parameters
Parameter Data Type Necessity Location Description
city name string optional query city name
Sample Request
curl --request GET \
  --url https://gateway.qymera.tech/qymera/sb/locations/v1/city/REPLACE_NAME \
  --header 'accept: application/json' \
  --header 'x-ibm-client-id: REPLACE_THIS_VALUE' \
  --header 'x-ibm-client-secret: REPLACE_THIS_VALUE'
Request

GET

https://gateway.qymera.tech/qymera/sb/locations/v1/city/Boac

Response

200

{
    "message": "Success.",
    "data": [
        {
            "id": "02bdb7e5-d03f-4e76-a221-820d0ebda21a",
            "company_id": "3aa1bbb0-4eb5-4583-85f4-3480089ae753",
            "branch_name": "Boac",
            "address_line_1": "10 De Oktubre St.",
            "address_line_2": "Brgy. Malusak",
            "city": "Boac",
            "state_or_province": "Marinduque",
            "postal_code": "4900",
            "country": "Philippines",
            "contact_no": "(042) 332-1872, Fax No. (042) 332-1872",
            "longitude": "121.839911",
            "latitude": "13.447544",
            "created_at": "2019-09-16T17:59:48.000Z",
            "updated_at": null
        }
    ]
}

404

{
    "httpCode": "404",
    "httpMessage": "Not Found",
    "moreInformation": "No resources match requested URI"
}
/company/:companyName
Implementation Notes

Get data by comapny name.

Parameters
Parameter Data Type Necessity Location Description
company name string required query Company name
Sample Request
curl --request GET \
  --url https://gateway.qymera.tech/qymera/sb/locations/v1/company/REPLACE_COMPANYNAME \
  --header 'accept: application/json' \
  --header 'x-ibm-client-id: REPLACE_THIS_VALUE' \
  --header 'x-ibm-client-secret: REPLACE_THIS_VALUE'
Request

GET

https://gateway.qymera.tech/qymera/sb/locations/v1/company/SSS

Response

200

{
    "message": "Success.",
    "data": [
        {
            "id": "0174de3a-c54f-4a15-961e-9ed0d90ac6df",
            "name": "SSS",
            "logo": null,
            "created_at": "2019-09-16T21:27:21.000Z",
            "updated_at": null,
            "company_id": "3aa1bbb0-4eb5-4583-85f4-3480089ae753",
            "branch_name": "Valencia",
            "address_line_1": "2/F Robinsons Place Valencia, Sayre Highway",
            "address_line_2": "Bagontaas",
            "city": "Valencia City",
            "state_or_province": "Bukidnon",
            "postal_code": "8709",
            "country": "Philippines",
            "contact_no": "(088) 828-0275, Fax No. (088) 222-3748",
            "longitude": "125.093608",
            "latitude": "7.922013"
        },
        {
            "id": "01e90a5a-b2c3-4781-b7eb-359ae79c6abc",
            "name": "SSS",
            "logo": null,
            "created_at": "2019-09-16T21:24:44.000Z",
            "updated_at": null,
            "company_id": "3aa1bbb0-4eb5-4583-85f4-3480089ae753",
            "branch_name": "Kalibo",
            "address_line_1": "G/F & 2/F Casa Constancia Bldg., Roxas Ave. Extension",
            "address_line_2": "Andagao",
            "city": "Kalibo",
            "state_or_province": "Aklan",
            "postal_code": "5600",
            "country": "Philippines",
            "contact_no": "(036) 262-1787, Fax No. (036) 500-8360",
            "longitude": "122.375103",
            "latitude": "11.702806"
        }
    ]
}

404

{
    "httpCode": "404",
    "httpMessage": "Not Found",
    "moreInformation": "No resources match requested URI"
}
/company/:companyName/city/:city
Implementation Notes

Get data by company name.

Parameters
Parameter Data Type Necessity Location Description
company name string required query Company name
city string required query city name
Sample Request
curl --request GET \
  --url https://gateway.qymera.tech/qymera/sb/locations/v1/company/REPLACE_COMPANYNAME/branch/REPLACE_BRANCHNAME \
  --header 'accept: application/json' \
  --header 'x-ibm-client-id: REPLACE_THIS_VALUE' \
  --header 'x-ibm-client-secret: REPLACE_THIS_VALUE'
Request

GET

https://gateway.qymera.tech/qymera/sb/locations/v1/company/SSS/city/Kalibo

Response

200

{
    "message": "Success.",
    "data": [
        {
            "id": "01e90a5a-b2c3-4781-b7eb-359ae79c6abc",
            "name": "SSS",
            "logo": null,
            "created_at": "2019-09-16T21:24:44.000Z",
            "updated_at": null,
            "company_id": "3aa1bbb0-4eb5-4583-85f4-3480089ae753",
            "branch_name": "Kalibo",
            "address_line_1": "G/F & 2/F Casa Constancia Bldg., Roxas Ave. Extension",
            "address_line_2": "Andagao",
            "city": "Kalibo",
            "state_or_province": "Aklan",
            "postal_code": "5600",
            "country": "Philippines",
            "contact_no": "(036) 262-1787, Fax No. (036) 500-8360",
            "longitude": "122.375103",
            "latitude": "11.702806"
        },
        {
            "id": "39363b07-2a14-4dfb-b854-4bf6eb26b572",
            "name": "SSS",
            "logo": null,
            "created_at": "2019-09-16T21:24:44.000Z",
            "updated_at": null,
            "company_id": "3aa1bbb0-4eb5-4583-85f4-3480089ae753",
            "branch_name": "Kalibo PEC",
            "address_line_1": "G/F & 2/F Casa Constancia Bldg., Roxas Ave. Extension",
            "address_line_2": "Andagao",
            "city": "Kalibo",
            "state_or_province": "Aklan",
            "postal_code": "5600",
            "country": "Philippines",
            "contact_no": "(036) 320-1966, (036) 268-4117",
            "longitude": "122.375103",
            "latitude": "11.702806"
        }
    ]
}

404

{
    "httpCode": "404",
    "httpMessage": "Not Found",
    "moreInformation": "No resources match requested URI"
}
/company/:companyName/branch/:branchName
Implementation Notes

Get data by city name.

Parameters
Parameter Data Type Necessity Location Description
branch name string optional query branch name
company name string optional query company name
Sample Request
curl --request GET \
  --url https://gateway.qymera.tech/qymera/sb/locations/v1/company/REPLACE_COMPANYNAME/branch/REPLACE_BRANCHNAME \
  --header 'accept: application/json' \
  --header 'x-ibm-client-id: REPLACE_THIS_VALUE' \
  --header 'x-ibm-client-secret: REPLACE_THIS_VALUE'
Request

GET

https://gateway.qymera.tech/qymera/sb/locations/v1/company/SSS/branch/valencia

Response

200

{
    "message": "Success.",
    "data": [
        {
            "id": "0174de3a-c54f-4a15-961e-9ed0d90ac6df",
            "name": "SSS",
            "logo": null,
            "created_at": "2019-09-16T21:27:21.000Z",
            "updated_at": null,
            "company_id": "3aa1bbb0-4eb5-4583-85f4-3480089ae753",
            "branch_name": "Valencia",
            "address_line_1": "2/F Robinsons Place Valencia, Sayre Highway",
            "address_line_2": "Bagontaas",
            "city": "Valencia City",
            "state_or_province": "Bukidnon",
            "postal_code": "8709",
            "country": "Philippines",
            "contact_no": "(088) 828-0275, Fax No. (088) 222-3748",
            "longitude": "125.093608",
            "latitude": "7.922013"
        },
        {
            "id": "861b74d2-b52a-48ff-a48b-b4316088b4eb",
            "name": "SSS",
            "logo": null,
            "created_at": "2019-09-16T21:27:21.000Z",
            "updated_at": null,
            "company_id": "3aa1bbb0-4eb5-4583-85f4-3480089ae753",
            "branch_name": "Valencia PEC",
            "address_line_1": "Cap Bldg., Sayre Highway",
            "address_line_2": "Hagcol",
            "city": "Valencia City",
            "state_or_province": "Bukidnon",
            "postal_code": "8709",
            "country": "Philippines",
            "contact_no": "(088) 828-0275",
            "longitude": "N/A",
            "latitude": "N/A"
        }
    ]
}

404

{
    "httpCode": "404",
    "httpMessage": "Not Found",
    "moreInformation": "No resources match requested URI"
}