Skip to main content
GET
/
datasources
/
mx
/
addresses
/
{postalCode}
Retrieve MX addresses by postal code
curl --request GET \
  --url https://api.syntage.com/datasources/mx/addresses/{postalCode} \
  --header 'X-API-Key: <api-key>'
{
  "@context": "/contexts/MxPostalCodeAddress",
  "@id": "/datasources/mx/addresses/11510",
  "@type": "hydra:Collection",
  "hydra:member": [
    {
      "@id": "/.well-known/genid/f2d82cee1ffcca39dbd2",
      "@type": "MxPostalCodeAddress",
      "postalCode": "11510",
      "neighborhood": "Los Morales",
      "neighborhoodType": "Colonia",
      "municipality": "Miguel Hidalgo",
      "state": "Ciudad de México",
      "stateCode": "CMX",
      "city": "Cd de Mexico",
      "officeKey": "01234"
    }
  ],
  "hydra:totalItems": 1,
  "hydra:view": {
    "@id": "<string>",
    "@type": "hydra:PartialCollectionView",
    "hydra:first": "<string>",
    "hydra:next": "<string>",
    "hydra:last": "<string>"
  },
  "hydra:search": {
    "@type": "<string>",
    "hydra:template": "<string>",
    "hydra:variableRepresentation": "<string>",
    "hydra:mapping": [
      {
        "@type": "<string>",
        "variable": "<string>",
        "property": "<string>",
        "required": true
      }
    ]
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.syntage.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-Key
string
header
required

Your API key is available in the Production and Sandbox dashboards.

Path Parameters

​
postalCode
string
required
Example:

"11510"

Response

MX addresses

​
@context
string
Example:

"/contexts/MxPostalCodeAddress"

​
@id
string
Example:

"/datasources/mx/addresses/11510"

​
@type
string
default:hydra:Collection
​
hydra:member
object[]
​
hydra:totalItems
integer

The total number of items found

Required range: x >= 0
Example:

1

​
hydra:view
object

Pagination information

​
hydra:search
object