# Property Boundary API

Shape files API and property search API.  All requests return the parcel boundaries in GEOJSON format.  Quickly implement this API into your mapping applications.  

Questions on how to best implement this API into your map?  Just reach out to our team for best practices with using this API.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "property-apis",
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://api.realestateapi.com"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "apiKey",
        "in": "header",
        "name": "x-api-key"
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/v1/PropertyParcel": {
      "post": {
        "summary": "Property Boundary API",
        "description": "Shape files API and property search API.  All requests return the parcel boundaries in GEOJSON format.  Quickly implement this API into your mapping applications.  \n\nQuestions on how to best implement this API into your map?  Just reach out to our team for best practices with using this API.",
        "operationId": "property-parcel-api",
        "parameters": [
          {
            "name": "x-user-id",
            "in": "header",
            "description": "Denote a unique user identifier to this api call by passing it in this header field",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "integer",
                    "description": "A property ID from any Property Search API result record. If this ID is provided, no other fields are required",
                    "format": "int32"
                  },
                  "address": {
                    "type": "string",
                    "description": "A fully formatted address with the following format: 123 Main St, Arlington VA 22205. When this field is provided and is in the valid format, no other fields are required"
                  },
                  "house": {
                    "type": "string",
                    "description": "House number field is to be used with the street, city, state, and zip fields (& unit if applicable)"
                  },
                  "unit": {
                    "type": "string"
                  },
                  "street": {
                    "type": "string"
                  },
                  "city": {
                    "type": "string"
                  },
                  "state": {
                    "type": "string",
                    "description": "The state code for the desired state (e.g. Virginia = VA)"
                  },
                  "county": {
                    "type": "string"
                  },
                  "zip": {
                    "type": "string",
                    "description": "5-digit zipcodes only"
                  },
                  "apn": {
                    "type": "string"
                  },
                  "fips": {
                    "type": "string"
                  },
                  "radius": {
                    "type": "number",
                    "format": "double"
                  },
                  "latitude": {
                    "type": "number",
                    "format": "double"
                  },
                  "longitude": {
                    "type": "number",
                    "format": "double"
                  },
                  "polygon": {
                    "type": "array",
                    "items": {
                      "properties": {
                        "lat": {
                          "type": "number",
                          "format": "double"
                        },
                        "lon": {
                          "type": "number",
                          "format": "double"
                        }
                      },
                      "type": "object"
                    }
                  },
                  "resultIndex": {
                    "type": "integer",
                    "format": "int32"
                  },
                  "size": {
                    "type": "integer",
                    "format": "int32"
                  }
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [
      {
        "key": "x-user-id",
        "value": "UniqueUserIdentifier"
      }
    ],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```