This is a generic attribute used to hold miscellaneous information not covered by any other attribute. Includes “value” (for the attribute itself), “type” (a name: e.g., “Real property description”), and “extra” (a miscellaneous field to hold any other details).
Field
Optional
Type
Description
value
✔
string
The additional information itself
type
✔
string
The type of additional information being conveyed
Address
A physical location description. Addresses may exist as a simple string (“123 South Main St., South Bend, IN 46556”), or may be in smaller chunks with separate fields (“Number: 123”, “Street name: South Main …”). Where possible, these fields will be parsed using the Libpostal ontology, which facilitates more robust address analysis and comparison.
Field
Optional
Type
Description
value
string
A single string that expresses the entire address. If this is created in the parser, it should run from the most specific part of the address to the least specific.
The language in which the address was provided in the record
house
✔
string
Building/site name (e.g., “Brooklyn Academy of Music”, “Empire State Building”)
house_number
✔
string
Usually refers to the external (street-facing) building number. In some jurisdictions, this may be a compound number that also includes an apartment/block number.
po_box
✔
string
Typically found in non-physical (mail-only) addresses
building
✔
string
entrance
✔
string
Numbered/lettered entrance
staircase
✔
string
Numbered/lettered staircase
level
✔
string
Expressions indicating a floor number (e.g., “3rd Floor”, “Ground Floor”)
unit
✔
string
An apartment, unit, office, lot, or other secondary unit designator
road
✔
string
Street name(s)
metro_station
✔
string
suburb
✔
string
Usually an unofficial neighborhood name, like “Harlem”, “South Bronx”, or “Crown Heights”
city_district
✔
string
Boroughs or districts within a city that serve some official purpose (e.g., “Brooklyn”, “Hackney”, or “Bratislava IV”)
city
✔
string
Any human settlement, including cities, towns, villages, hamlets, localities, etc.
state_district
✔
string
A second-level administrative division or county
island
✔
string
Named islands (e.g., “Maui”)
state
✔
string
A first-level administrative division, including provinces and departments. Scotland, Northern Ireland, Wales, and England in the UK are also mapped to “state” (convention commonly used in geocoding tools).
postcode
✔
string
Postal codes used for mail sorting
country_region
✔
string
Informal subdivision of a country without any political status
country
✔
string
Sovereign nations and their dependent territories; anything with an ISO 3166 code
world_region
✔
string
Currently only used for appending “West Indies” after the country name, a pattern frequently used in the English-speaking Caribbean (e.g., “Jamaica, West Indies”)
category
✔
string
For category queries like “restaurants”, etc.
near
✔
string
Phrases like “in”, “near”, etc. used after a category phrase, to help with parsing queries like “restaurants in Brooklyn”
x
✔
double
The X coordinate (longitude) of the address
y
✔
double
The Y coordinate (latitude) of the address
precision_code
✔
string
A code describing the precision of the X and Y coordinates
Business Purpose
Text and/or a code (NAICS, NACE, ISIC, etc.) that describes what a company is legally allowed to do or produce
An attribute used for many different relationship types that allows for the inclusion of a title or designation (e.g., member_of_the_board_of, Position: “Secretary of the Board” or shareholder_of, Position: “Minority shareholder”)
A string describing the type of shares (e.g., “Class B”, “Protected cell shares”)
Status
The status of an entity. This attribute is used to indicate details such as registration, operating, or liquidation status as well as an entity’s license or sole proprietorship status.