Searching for an Address and Permits

Requests should be initiated to the following url https://permits.himaintenance.io/
Header should contain x-api-key parameter which can be requested here

Address Search URL

/POST

https://permits.himaintenance.io/search-api/v5/address_search

Accepted Parameters for Above URL
  • building_number
  • street_address
  • city
  • state
  • zip
Status for Searched Address URL

/GET

https://permits.himaintenance.io/search-api/v5/get_status/

Accepted Parameters for Above URL
  • reference_id
Get Permits for Searched Address URL

/GET

https://permits.himaintenance.io/search-api/v5/get_permits

Accepted Parameters for Above URL
  • address_id

Scenario Base Result

Scenario:- 1
Simple Address Without Unit

/POST

https://permits.himaintenance.io/search-api/v5/address_search?building_number=1123&street_address=PARK%20HILLS%20RD&city=BERKELEY&state=CA&zip=94708

Query Param Value
building_number 1123
street_address PARK HILLS RD
city BERKELEY
state CA
zip 94708
unit -
Response Body with status code
200
{
    "reference_id": "3ca4e53b984143aaac140e2ee7105026",
      "request_address": {
        "building_number": "1123",
          "street_address": "PARK HILLS RD",
          "city": "BERKELEY",
          "state": "CA",
          "zip": "94708"
        },
        "status": "IN_PROGRESS"
        "creation_timestamp": "2025-10-25T05:42:28.231397"

      }

/GET

https://permits.himaintenance.io/search-api/v5/get_status/?reference_id=3ca4e53b984143aaac140e2ee7105026

Query Param Value
reference_id 3ca4e53b984143aaac140e2ee7105026
Response Body with status code
200
{
    "address_result": [
      {
          "address_id": "3ca4e53b984143aaac140e2ee7105026-P1208600485016",
          "match_score": 1.0,
          "full_address": "1123 PARK HILLS RD BERKELEY CA 94708",
        },
        {
          "address_id": "3ca4e53b984143aaac140e2ee7105026-P1208600142241",
          "match_score": 0.8962544,
          "full_address": "1123 PARK HILLS ST BERKELEY CA 94708",
        },
    ]
      "request_address": {
          "building_number": "1123",
          "street_address": "PARK HILLS RD",
          "city": "BERKELEY",
          "state": "CA",
          "zip": "94708"
        },
        "status": "ADDRESS_FOUND"
  }

/GET

https://permits.himaintenance.io/search-api/v5/get_permits?address_id=3ca4e53b984143aaac140e2ee7105026-P1208600485016

Query Param Value
address_id 3ca4e53b984143aaac140e2ee7105026-P1208600485016
Response Body with status code
200
{
  "response": {
    "status_message": "success",
    "permits": [
      {
        "address_details": {
          "unit": null,
          "level": "NO_DATA",
          "number": "1123",
          "street": "PARK HILLS RD",
          "city": "BERKELEY",
          "state": "CA",
          "zip": "94708",
          "latitude": "NO_DATA",
          "longitude": "NO_DATA",
          "property_id": "P1208600485016",
          "last_refreshed_date": "2025-04-15"
        },
        "match_score": 1.0,
        "permit_details": [
          {
            "permit_number": "B2015-00557",
            "permit_status": "Closed",
            "permit_category": "Building Permit",
            "permit_type": "Building Addition",
            "permit_sub_type": null,
            "permit_class": null,
            "work_description": "REPLACING 50GAL WATER HEATER (0.69 ENERGY FACTOR) IN SAME LOCATION.",
            "permit_applied_date": null,
            "permit_status_date": null,
            "permit_expiry_date": null,
            "permit_issued_date": null,
            "permit_fees": null,
            "valuation": null,
            "pin": null,
            "parcel_id": "063 315004900",
            "master_permit_number": null,
            "units": null,
            "stories": null,
            "total_sqft": null,
            "comments": "Work Type: Alteration, Job Valuation: 0",
            "permit_issued_office": null,
            "permit_id": 1260140,
            "contractor_details": null,
            "owner_details": [
              {
                "owner_name": null,
                "owner_address": "1123 PARK HILLS RD,BERKELEY CA 94708",
                "owner_organization": "ONEILL DAVID D & MARY V TRS",
                "owner_contact_number": null
              }
            ],
            "applicant_details": [
              {
                "applicant_name": "BIG BLUE PLUMB/ PAUL GERRARD",
                "applicant_address": "2311 SAN PABLO AVE BERKELEY,, CA,, 94702",
                "applicant_phone": "5105406060, ",
                "applicant_organization": null
              }
            ]
          },
          {
            "permit_number": "B2019-03675",
            "permit_status": "Issued",
            "permit_category": "Building Permit",
            "permit_type": "Building Addition",
            "permit_sub_type": null,
            "permit_class": null,
            "work_description": "Install EV charger in garage",
            "permit_applied_date": null,
            "permit_status_date": null,
            "permit_expiry_date": null,
            "permit_issued_date": "2019-08-30",
            "permit_fees": "$127.00",
            "valuation": null,
            "pin": null,
            "parcel_id": "063 315004900",
            "master_permit_number": null,
            "units": null,
            "stories": null,
            "total_sqft": null,
            "comments": "Category: Residential, Work Type: Alteration, Job Valuation: 0",
            "permit_issued_office": null,
            "permit_id": 1260135,
            "contractor_details": null,
            "owner_details": null,
            "applicant_details": [
              {
                "applicant_name": "David O'Neil",
                "applicant_address": "1123 PARK HILLS RD BERKELEY,, CA,, 94708-1715",
                "applicant_phone": "(510)841-0141",
                "applicant_organization": null
              }
            ]
          },
          {
            "permit_number": "B2016-01442",
            "permit_status": "Closed",
            "permit_category": "Building Permit",
            "permit_type": "Building Addition",
            "permit_sub_type": null,
            "permit_class": null,
            "work_description": "ATTIC INSULATION, HEATING FURNACE AND DUCT REPLACEMENT, NEW DEDICATED LIGHT SWITCH AND GFCI IN FURNACE ROOM",
            "permit_applied_date": null,
            "permit_status_date": null,
            "permit_expiry_date": null,
            "permit_issued_date": "2016-04-01",
            "permit_fees": "$911.55",
            "valuation": "$18,000.00",
            "pin": null,
            "parcel_id": "063 315004900",
            "master_permit_number": null,
            "units": null,
            "stories": null,
            "total_sqft": null,
            "comments": "Category: Residential, Work Type: Alteration, Job Valuation: 18000",
            "permit_issued_office": null,
            "permit_id": 1260139,
            "contractor_details": [
              {
                "contractor_name": null,
                "contractor_organization": "HASSLER HEATING & AIR CONDITIO",
                "contractor_phone": "5108483030",
                "contractor_address": "BL-033358,1537 S 56TH ST",
                "contractor_license_type": null,
                "contractor_license_number": "5108483030",
                "contractor_type": "CONTRACTOR"
              }
            ],
            "owner_details": [
              {
                "owner_name": null,
                "owner_address": "1123 PARK HILLS RD,BERKELEY CA 94708",
                "owner_organization": "ONEILL DAVID D & MARY V TRS",
                "owner_contact_number": null
              }
            ],
            "applicant_details": [
              {
                "applicant_name": null,
                "applicant_address": "1537 S 56TH ST EL CERRITO,, CA,, 94530-2107",
                "applicant_phone": "(510)848-3030",
                "applicant_organization": "HASSLER HEATING & AIR CONDITIONING"
              }
            ]
          }
        ],
        "inspection_details": [
          {
            "inspection_number": "B2015-00557",
            "inspection_status": null,
            "inspection_type": "Building Addition",
            "work_description": "REPLACING 50GAL WATER HEATER (0.69 ENERGY FACTOR) IN SAME LOCATION.",
            "inspection_applied_date": null,
            "inspection_status_date": null,
            "inspection_scheduled_date": null,
            "inspection_fees": null,
            "inspection_valuation": null,
            "parcel_id": "063 315004900",
            "master_permit_number": null,
            "comments": "Work Type: Alteration, Job Valuation: 0",
            "inspector_name": "JOHN GERRY",
            "inspector_phone": null,
            "inspection_id": 1260140,
            "contractor_details": null,
            "owner_details": null,
            "applicant_details": null
          },
          {
            "inspection_number": "B2019-03675",
            "inspection_status": null,
            "inspection_type": "Building Addition",
            "work_description": "Install EV charger in garage",
            "inspection_applied_date": null,
            "inspection_status_date": null,
            "inspection_scheduled_date": "2019-08-30",
            "inspection_fees": "$127.00",
            "inspection_valuation": null,
            "parcel_id": "063 315004900",
            "master_permit_number": null,
            "comments": "Category: Residential, Work Type: Alteration, Job Valuation: 0",
            "inspector_name": "PAUL GERRARD",
            "inspector_phone": null,
            "inspection_id": 1260135,
            "contractor_details": null,
            "owner_details": null,
            "applicant_details": null
          }
        ]
      }
    ],
    "metadata": {
      "tx_start_time": "2025-11-03T06:23:47.984603",
      "txn_id": "57281458236245a7b757f9641e8e9302",
      "request": {
        "building_number": "1123",
        "city": "BERKELEY",
        "state": "CA",
        "street_address": "PARK HILLS RD",
        "zip": "94708"
      },
      "total_valuation": 287095.0,
      "count_of_permits": 3,
      "count_of_inspections": 2,
      "response_time": "1.13s"
      }
    }
}

Scenario:- 2
Simple Address With Unit

/POST

https://permits.himaintenance.io/search-api/v5/address_search?building_number=1123&street_address=PARK%20HILLS%20RD%20115&city=BERKELEY&state=CA&zip=94708

Query Param Value
building_number 1123
street_address PARK HILLS RD 115
city BERKELEY
state CA
zip 94708
unit -
Response Body with status code
200
{
    "reference_id": "ae3811d2e43a4dfbb8e04291f59e0cd5",
      "request_address": {
        "building_number": "1123",
          "street_address": "PARK HILLS RD 115",
          "city": "BERKELEY",
          "state": "CA",
          "zip": "94708"
        },
        "status": "IN_PROGRESS"
        "creation_timestamp": "2024-10-29T05:42:28.231397"

      }

/GET

https://permits.himaintenance.io/search-api/v5/get_status/?reference_id=ae3811d2e43a4dfbb8e04291f59e0cd5

Query Param Value
reference_id ae3811d2e43a4dfbb8e04291f59e0cd5
Response Body with status code
200
{
    "address_result": [
        {
          "address_id": "ae3811d2e43a4dfbb8e04291f59e0cd5-P1208600142241",
          "match_score": 0.88183916,
          "full_address": "1123 PARK HILLS RD 115 BERKELEY CA 94708",
        }
    ]
        "request_address": {
          "building_number": "1123",
          "street_address": "PARK HILLS RD 115",
          "city": "BERKELEY",
          "state": "CA",
          "zip": "94708"
        },
        "status": "ADDRESS_FOUND"
  }

/GET

https://permits.himaintenance.io/search-api/v5/get_permits?address_id=ae3811d2e43a4dfbb8e04291f59e0cd5-P1208600142241

Query Param Value
address_id ae3811d2e43a4dfbb8e04291f59e0cd5-P1208600142241
Response Body with status code
200
{
  "response": {
    "status_message": "success",
    "permits": [
      {
        "address_details": {
          "unit": null,
          "level": "NO_DATA",
          "number": "1100",
          "street": "PARK HILLS RD",
          "city": "BERKELEY",
          "state": "CA",
          "zip": "94708",
          "latitude": "NO_DATA",
          "longitude": "NO_DATA",
          "property_id": "P1208600142241",
          "last_refreshed_date": "2025-04-15"
        },
        "match_score": 1.0,
        "permit_details": [
          {
            "permit_number": "B2015-00559",
            "permit_status": "Closed",
            "permit_category": "Building Permit",
            "permit_type": "Building Addition",
            "permit_sub_type": null,
            "permit_class": null,
            "work_description": "REPLACING 50GAL WATER HEATER (0.69 ENERGY FACTOR) IN SAME LOCATION.",
            "permit_applied_date": null,
            "permit_status_date": null,
            "permit_expiry_date": null,
            "permit_issued_date": null,
            "permit_fees": null,
            "valuation": null,
            "pin": null,
            "parcel_id": "063 315004900",
            "master_permit_number": null,
            "units": null,
            "stories": null,
            "total_sqft": null,
            "comments": "Work Type: Alteration, Job Valuation: 0",
            "permit_issued_office": null,
            "permit_id": 1260140,
            "contractor_details": null,
            "owner_details": [
              {
                "owner_name": null,
                "owner_address": "1100 PARK HILLS RD,BERKELEY CA 94708",
                "owner_organization": "ONEILL DAVID D & MARY V TRS",
                "owner_contact_number": null
              }
            ],
            "applicant_details": [
              {
                "applicant_name": "BIG BLUE PLUMB/ PAUL GERRARD",
                "applicant_address": "2311 SAN PABLO AVE BERKELEY,, CA,, 94702",
                "applicant_phone": "5105406060, ",
                "applicant_organization": null
              }
            ]
          },
          {
            "permit_number": "B2019-03675",
            "permit_status": "Issued",
            "permit_category": "Building Permit",
            "permit_type": "Building Addition",
            "permit_sub_type": null,
            "permit_class": null,
            "work_description": "Install EV charger in garage",
            "permit_applied_date": null,
            "permit_status_date": null,
            "permit_expiry_date": null,
            "permit_issued_date": "2019-08-30",
            "permit_fees": "$127.00",
            "valuation": null,
            "pin": null,
            "parcel_id": "063 315004900",
            "master_permit_number": null,
            "units": null,
            "stories": null,
            "total_sqft": null,
            "comments": "Category: Residential, Work Type: Alteration, Job Valuation: 0",
            "permit_issued_office": null,
            "permit_id": 1260135,
            "contractor_details": null,
            "owner_details": null,
            "applicant_details": [
              {
                "applicant_name": "David O'Neil",
                "applicant_address": "1100 PARK HILLS RD BERKELEY,, CA,, 94708-1715",
                "applicant_phone": "(510)841-0141",
                "applicant_organization": null
              }
            ]
          },
          {
            "permit_number": "B2016-01442",
            "permit_status": "Closed",
            "permit_category": "Building Permit",
            "permit_type": "Building Addition",
            "permit_sub_type": null,
            "permit_class": null,
            "work_description": "ATTIC INSULATION, HEATING FURNACE AND DUCT REPLACEMENT, NEW DEDICATED LIGHT SWITCH AND GFCI IN FURNACE ROOM",
            "permit_applied_date": null,
            "permit_status_date": null,
            "permit_expiry_date": null,
            "permit_issued_date": "2016-04-01",
            "permit_fees": "$911.55",
            "valuation": "$18,000.00",
            "pin": null,
            "parcel_id": "063 315004900",
            "master_permit_number": null,
            "units": null,
            "stories": null,
            "total_sqft": null,
            "comments": "Category: Residential, Work Type: Alteration, Job Valuation: 18000",
            "permit_issued_office": null,
            "permit_id": 1260139,
            "contractor_details": [
              {
                "contractor_name": null,
                "contractor_organization": "HASSLER HEATING & AIR CONDITIO",
                "contractor_phone": "5108483030",
                "contractor_address": "BL-033358,1537 S 56TH ST",
                "contractor_license_type": null,
                "contractor_license_number": "5108483030",
                "contractor_type": "CONTRACTOR"
              }
            ],
            "owner_details": [
              {
                "owner_name": null,
                "owner_address": "1100 PARK HILLS RD,BERKELEY CA 94708",
                "owner_organization": "ONEILL DAVID D & MARY V TRS",
                "owner_contact_number": null
              }
            ],
            "applicant_details": [
              {
                "applicant_name": null,
                "applicant_address": "1537 S 56TH ST EL CERRITO,, CA,, 94530-2107",
                "applicant_phone": "(510)848-3030",
                "applicant_organization": "HASSLER HEATING & AIR CONDITIONING"
              }
            ]
          }
        ],
        "inspection_details": [
          {
            "inspection_number": "B2015-00557",
            "inspection_status": null,
            "inspection_type": "Building Addition",
            "work_description": "REPLACING 50GAL WATER HEATER (0.69 ENERGY FACTOR) IN SAME LOCATION.",
            "inspection_applied_date": null,
            "inspection_status_date": null,
            "inspection_scheduled_date": null,
            "inspection_fees": null,
            "inspection_valuation": null,
            "parcel_id": "063 315004900",
            "master_permit_number": null,
            "comments": "Work Type: Alteration, Job Valuation: 0",
            "inspector_name": "JOHN GERRY",
            "inspector_phone": null,
            "inspection_id": 1260140,
            "contractor_details": null,
            "owner_details": null,
            "applicant_details": null
          },
          {
            "inspection_number": "B2019-03695",
            "inspection_status": null,
            "inspection_type": "Building Alteration",
            "work_description": "Install EV charger in garage",
            "inspection_applied_date": null,
            "inspection_status_date": null,
            "inspection_scheduled_date": "2019-08-30",
            "inspection_fees": "$125.00",
            "inspection_valuation": null,
            "parcel_id": "063 315004900",
            "master_permit_number": null,
            "comments": "Category: Residential, Work Type: Alteration, Job Valuation: 0",
            "inspector_name": "RICK MARTIN",
            "inspector_phone": null,
            "inspection_id": 1260133,
            "contractor_details": null,
            "owner_details": null,
            "applicant_details": null
          }
        ]
      }
    ],
    "metadata": {
      "tx_start_time": "2025-11-03T06:23:47.984603",
      "txn_id": "57281458236245a7b757f9641e8e9302",
      "request": {
        "building_number": "1100",
        "city": "BERKELEY",
        "state": "CA",
        "street_address": "PARK HILLS RD",
        "zip": "94708"
      },
      "total_valuation": 287095.0,
      "count_of_permits": 3,
      "count_of_inspections": 2,
      "response_time": "1.13s"
      }
    }
}

Scenario:- 3
Address Without Building Number

/POST

https://permits.himaintenance.io/search-api/v5/address_search?building_number=&street_address=PARK%20HILLS%20RD&city=BERKELEY&state=CA&zip=94708

Query Param Value
building_number -
street_address PARK HILLS RD
city BERKELEY
state CA
zip 94708
unit -
Response Body with status code
200
{
    "reference_id": "73e84c4453e141bba5ddc1773430a4b3",
      "request_address": {
        "building_number": "",
          "street_address": "PARK HILLS RD",
          "city": "BERKELEY",
          "state": "CA",
          "zip": "94708"
        },
        "status": "IN_PROGRESS"
        "creation_timestamp": "2024-09-25T05:42:28.231397"

      }

/GET

https://permits.himaintenance.io/search-api/v5/get_status/?reference_id=73e84c4453e141bba5ddc1773430a4b3

Query Param Value
reference_id 73e84c4453e141bba5ddc1773430a4b3
Response Body with status code
200
{
    "address_result": [
      {
          "address_id": "73e84c4453e141bba5ddc1773430a4b3-P1208600485016",
          "match_score": 0.88183916,
          "full_address": "1110 PARK HILLS RD BERKELEY CA 94708",
        },
        {
          "address_id": "73e84c4453e141bba5ddc1773430a4b3-P1208600142241",
          "match_score": 0.8762544,
          "full_address": "1100 PARK HILLS RD BERKELEY CA 94708",
        },
        {
          "address_id": "73e84c4453e141bba5ddc1773430a4b3-P1208600142948",
          "match_score": 0.8627544,
          "full_address": "1001 PARK HILLS RD BERKELEY CA 94708",
        },
        {
          "address_id": "73e84c4453e141bba5ddc1773430a4b3-P1208600125811",
          "match_score": 0.78563916,
          "full_address": "950 PARK HILLS RD BERKELEY CA 94708",
        },
        {
          "address_id": "73e84c4453e141bba5ddc1773430a4b3-P1208600125804",
          "match_score": 0.7856544,
          "full_address": "940 PARK HILLS RD BERKELEY CA 94708",
        },
    ]
      "request_address": {
          "building_number": "1123",
          "street_address": "PARK HILLS RD",
          "city": "BERKELEY",
          "state": "CA",
          "zip": "94708"
        },
        "status": "ADDRESS_FOUND"
  }

/GET

https://permits.himaintenance.io/search-api/v5/get_permits?address_id=73e84c4453e141bba5ddc1773430a4b3-P1208600142241

Query Param Value
address_id 73e84c4453e141bba5ddc1773430a4b3-P1208600142241
Response Body with status code
200
{
  "response": {
    "status_message": "success",
    "permits": [
      {
        "address_details": {
          "unit": null,
          "level": "NO_DATA",
          "number": "1100",
          "street": "PARK HILLS RD",
          "city": "BERKELEY",
          "state": "CA",
          "zip": "94708",
          "latitude": "NO_DATA",
          "longitude": "NO_DATA",
          "property_id": "P1208600142241",
          "last_refreshed_date": "2025-04-15"
        },
        "match_score": 1.0,
        "permit_details": [
          {
            "permit_number": "B2015-00559",
            "permit_status": "Closed",
            "permit_category": "Building Permit",
            "permit_type": "Building Addition",
            "permit_sub_type": null,
            "permit_class": null,
            "work_description": "REPLACING 50GAL WATER HEATER (0.69 ENERGY FACTOR) IN SAME LOCATION.",
            "permit_applied_date": null,
            "permit_status_date": null,
            "permit_expiry_date": null,
            "permit_issued_date": null,
            "permit_fees": null,
            "valuation": null,
            "pin": null,
            "parcel_id": "063 315004900",
            "master_permit_number": null,
            "units": null,
            "stories": null,
            "total_sqft": null,
            "comments": "Work Type: Alteration, Job Valuation: 0",
            "permit_issued_office": null,
            "permit_id": 1260140,
            "contractor_details": null,
            "owner_details": [
              {
                "owner_name": null,
                "owner_address": "1100 PARK HILLS RD,BERKELEY CA 94708",
                "owner_organization": "ONEILL DAVID D & MARY V TRS",
                "owner_contact_number": null
              }
            ],
            "applicant_details": [
              {
                "applicant_name": "BIG BLUE PLUMB/ PAUL GERRARD",
                "applicant_address": "2311 SAN PABLO AVE BERKELEY,, CA,, 94702",
                "applicant_phone": "5105406060, ",
                "applicant_organization": null
              }
            ]
          },
          {
            "permit_number": "B2019-03675",
            "permit_status": "Issued",
            "permit_category": "Building Permit",
            "permit_type": "Building Addition",
            "permit_sub_type": null,
            "permit_class": null,
            "work_description": "Install EV charger in garage",
            "permit_applied_date": null,
            "permit_status_date": null,
            "permit_expiry_date": null,
            "permit_issued_date": "2019-08-30",
            "permit_fees": "$127.00",
            "valuation": null,
            "pin": null,
            "parcel_id": "063 315004900",
            "master_permit_number": null,
            "units": null,
            "stories": null,
            "total_sqft": null,
            "comments": "Category: Residential, Work Type: Alteration, Job Valuation: 0",
            "permit_issued_office": null,
            "permit_id": 1260135,
            "contractor_details": null,
            "owner_details": null,
            "applicant_details": [
              {
                "applicant_name": "David O'Neil",
                "applicant_address": "1100 PARK HILLS RD BERKELEY,, CA,, 94708-1715",
                "applicant_phone": "(510)841-0141",
                "applicant_organization": null
              }
            ]
          },
          {
            "permit_number": "B2016-01442",
            "permit_status": "Closed",
            "permit_category": "Building Permit",
            "permit_type": "Building Addition",
            "permit_sub_type": null,
            "permit_class": null,
            "work_description": "ATTIC INSULATION, HEATING FURNACE AND DUCT REPLACEMENT, NEW DEDICATED LIGHT SWITCH AND GFCI IN FURNACE ROOM",
            "permit_applied_date": null,
            "permit_status_date": null,
            "permit_expiry_date": null,
            "permit_issued_date": "2016-04-01",
            "permit_fees": "$911.55",
            "valuation": "$18,000.00",
            "pin": null,
            "parcel_id": "063 315004900",
            "master_permit_number": null,
            "units": null,
            "stories": null,
            "total_sqft": null,
            "comments": "Category: Residential, Work Type: Alteration, Job Valuation: 18000",
            "permit_issued_office": null,
            "permit_id": 1260139,
            "contractor_details": [
              {
                "contractor_name": null,
                "contractor_organization": "HASSLER HEATING & AIR CONDITIO",
                "contractor_phone": "5108483030",
                "contractor_address": "BL-033358,1537 S 56TH ST",
                "contractor_license_type": null,
                "contractor_license_number": "5108483030",
                "contractor_type": "CONTRACTOR"
              }
            ],
            "owner_details": [
              {
                "owner_name": null,
                "owner_address": "1100 PARK HILLS RD,BERKELEY CA 94708",
                "owner_organization": "ONEILL DAVID D & MARY V TRS",
                "owner_contact_number": null
              }
            ],
            "applicant_details": [
              {
                "applicant_name": null,
                "applicant_address": "1537 S 56TH ST EL CERRITO,, CA,, 94530-2107",
                "applicant_phone": "(510)848-3030",
                "applicant_organization": "HASSLER HEATING & AIR CONDITIONING"
              }
            ]
          }
        ],
        "inspection_details": [
          {
            "inspection_number": "B2015-00557",
            "inspection_status": null,
            "inspection_type": "Building Addition",
            "work_description": "REPLACING 50GAL WATER HEATER (0.69 ENERGY FACTOR) IN SAME LOCATION.",
            "inspection_applied_date": null,
            "inspection_status_date": null,
            "inspection_scheduled_date": null,
            "inspection_fees": null,
            "inspection_valuation": null,
            "parcel_id": "063 315004900",
            "master_permit_number": null,
            "comments": "Work Type: Alteration, Job Valuation: 0",
            "inspector_name": "JOHN GERRY",
            "inspector_phone": null,
            "inspection_id": 1260140,
            "contractor_details": null,
            "owner_details": null,
            "applicant_details": null
          },
          {
            "inspection_number": "B2019-03695",
            "inspection_status": null,
            "inspection_type": "Building Alteration",
            "work_description": "Install EV charger in garage",
            "inspection_applied_date": null,
            "inspection_status_date": null,
            "inspection_scheduled_date": "2019-08-30",
            "inspection_fees": "$125.00",
            "inspection_valuation": null,
            "parcel_id": "063 315004900",
            "master_permit_number": null,
            "comments": "Category: Residential, Work Type: Alteration, Job Valuation: 0",
            "inspector_name": "RICK MARTIN",
            "inspector_phone": null,
            "inspection_id": 1260133,
            "contractor_details": null,
            "owner_details": null,
            "applicant_details": null
          }
        ]
      }
    ],
    "metadata": {
      "tx_start_time": "2025-11-03T06:23:47.984603",
      "txn_id": "57281458236245a7b757f9641e8e9302",
      "request": {
        "building_number": "1100",
        "city": "BERKELEY",
        "state": "CA",
        "street_address": "PARK HILLS RD",
        "zip": "94708"
      },
      "total_valuation": 287095.0,
      "count_of_permits": 3,
      "count_of_inspections": 2,
      "response_time": "1.13s"
      }
    }
}

Scenario:- 4
Nearby Address Search

/POST

https://permits.himaintenance.io/search-api/v5/address_search?building_number=1123&street_address=PARK%20HILLS%20RD&city=BERKELEY&state=CA&zip=94708

Query Param Value
building_number 1123
street_address PARK HILLS RD
city BERKELEY
state CA
zip 94708
unit -
Response Body with status code
200
{
    "reference_id": "73e84c4453e141bba5ddc1773430a4b3",
      "request_address": {
        "building_number": "1123",
          "street_address": "PARK HILLS RD",
          "city": "BERKELEY",
          "state": "CA",
          "zip": "94708"
        },
        "status": "IN_PROGRESS"
        "creation_timestamp": "2024-09-25T05:42:28.231397"

      }

/GET

https://permits.himaintenance.io/search-api/v5/get_status/?reference_id=73e84c4453e141bba5ddc1773430a4b3

Query Param Value
reference_id 73e84c4453e141bba5ddc1773430a4b3
Response Body with status code
200
{
    "address_result": [
      {
          "address_id": "73e84c4453e141bba5ddc1773430a4b3-P1208600485016",
          "match_score": 0.88183916,
          "full_address": "1110 PARK HILLS RD BERKELEY CA 94708",
        },
        {
          "address_id": "73e84c4453e141bba5ddc1773430a4b3-P1208600142241",
          "match_score": 0.8762544,
          "full_address": "1100 PARK HILLS RD BERKELEY CA 94708",
        },
        {
          "address_id": "73e84c4453e141bba5ddc1773430a4b3-P1208600142948",
          "match_score": 0.8627544,
          "full_address": "1001 PARK HILLS RD BERKELEY CA 94708",
        },
        {
          "address_id": "73e84c4453e141bba5ddc1773430a4b3-P1208600125811",
          "match_score": 0.78563916,
          "full_address": "950 PARK HILLS RD BERKELEY CA 94708",
        },
        {
          "address_id": "73e84c4453e141bba5ddc1773430a4b3-P1208600125804",
          "match_score": 0.7856544,
          "full_address": "940 PARK HILLS RD BERKELEY CA 94708",
        },
    ]
      "request_address": {
          "building_number": "1123",
          "street_address": "PARK HILLS RD",
          "city": "BERKELEY",
          "state": "CA",
          "zip": "94708"
        },
        "status": "ADDRESS_FOUND"
  }

/GET

https://permits.himaintenance.io/search-api/v5/get_permits?address_id=73e84c4453e141bba5ddc1773430a4b3-P1208600142241

Query Param Value
address_id 73e84c4453e141bba5ddc1773430a4b3-P1208600142241
Response Body with status code
200
{
  "response": {
    "status_message": "success",
    "permits": [
      {
        "address_details": {
          "unit": null,
          "level": "NO_DATA",
          "number": "1100",
          "street": "PARK HILLS RD",
          "city": "BERKELEY",
          "state": "CA",
          "zip": "94708",
          "latitude": "NO_DATA",
          "longitude": "NO_DATA",
          "property_id": "P1208600142241",
          "last_refreshed_date": "2025-04-15"
        },
        "match_score": 1.0,
        "permit_details": [
          {
            "permit_number": "B2015-00559",
            "permit_status": "Closed",
            "permit_category": "Building Permit",
            "permit_type": "Building Addition",
            "permit_sub_type": null,
            "permit_class": null,
            "work_description": "REPLACING 50GAL WATER HEATER (0.69 ENERGY FACTOR) IN SAME LOCATION.",
            "permit_applied_date": null,
            "permit_status_date": null,
            "permit_expiry_date": null,
            "permit_issued_date": null,
            "permit_fees": null,
            "valuation": null,
            "pin": null,
            "parcel_id": "063 315004900",
            "master_permit_number": null,
            "units": null,
            "stories": null,
            "total_sqft": null,
            "comments": "Work Type: Alteration, Job Valuation: 0",
            "permit_issued_office": null,
            "permit_id": 1260140,
            "contractor_details": null,
            "owner_details": [
              {
                "owner_name": null,
                "owner_address": "1100 PARK HILLS RD,BERKELEY CA 94708",
                "owner_organization": "ONEILL DAVID D & MARY V TRS",
                "owner_contact_number": null
              }
            ],
            "applicant_details": [
              {
                "applicant_name": "BIG BLUE PLUMB/ PAUL GERRARD",
                "applicant_address": "2311 SAN PABLO AVE BERKELEY,, CA,, 94702",
                "applicant_phone": "5105406060, ",
                "applicant_organization": null
              }
            ]
          },
          {
            "permit_number": "B2019-03675",
            "permit_status": "Issued",
            "permit_category": "Building Permit",
            "permit_type": "Building Addition",
            "permit_sub_type": null,
            "permit_class": null,
            "work_description": "Install EV charger in garage",
            "permit_applied_date": null,
            "permit_status_date": null,
            "permit_expiry_date": null,
            "permit_issued_date": "2019-08-30",
            "permit_fees": "$127.00",
            "valuation": null,
            "pin": null,
            "parcel_id": "063 315004900",
            "master_permit_number": null,
            "units": null,
            "stories": null,
            "total_sqft": null,
            "comments": "Category: Residential, Work Type: Alteration, Job Valuation: 0",
            "permit_issued_office": null,
            "permit_id": 1260135,
            "contractor_details": null,
            "owner_details": null,
            "applicant_details": [
              {
                "applicant_name": "David O'Neil",
                "applicant_address": "1100 PARK HILLS RD BERKELEY,, CA,, 94708-1715",
                "applicant_phone": "(510)841-0141",
                "applicant_organization": null
              }
            ]
          },
          {
            "permit_number": "B2016-01442",
            "permit_status": "Closed",
            "permit_category": "Building Permit",
            "permit_type": "Building Addition",
            "permit_sub_type": null,
            "permit_class": null,
            "work_description": "ATTIC INSULATION, HEATING FURNACE AND DUCT REPLACEMENT, NEW DEDICATED LIGHT SWITCH AND GFCI IN FURNACE ROOM",
            "permit_applied_date": null,
            "permit_status_date": null,
            "permit_expiry_date": null,
            "permit_issued_date": "2016-04-01",
            "permit_fees": "$911.55",
            "valuation": "$18,000.00",
            "pin": null,
            "parcel_id": "063 315004900",
            "master_permit_number": null,
            "units": null,
            "stories": null,
            "total_sqft": null,
            "comments": "Category: Residential, Work Type: Alteration, Job Valuation: 18000",
            "permit_issued_office": null,
            "permit_id": 1260139,
            "contractor_details": [
              {
                "contractor_name": null,
                "contractor_organization": "HASSLER HEATING & AIR CONDITIO",
                "contractor_phone": "5108483030",
                "contractor_address": "BL-033358,1537 S 56TH ST",
                "contractor_license_type": null,
                "contractor_license_number": "5108483030",
                "contractor_type": "CONTRACTOR"
              }
            ],
            "owner_details": [
              {
                "owner_name": null,
                "owner_address": "1100 PARK HILLS RD,BERKELEY CA 94708",
                "owner_organization": "ONEILL DAVID D & MARY V TRS",
                "owner_contact_number": null
              }
            ],
            "applicant_details": [
              {
                "applicant_name": null,
                "applicant_address": "1537 S 56TH ST EL CERRITO,, CA,, 94530-2107",
                "applicant_phone": "(510)848-3030",
                "applicant_organization": "HASSLER HEATING & AIR CONDITIONING"
              }
            ]
          }
        ],
        "inspection_details": [
          {
            "inspection_number": "B2015-00557",
            "inspection_status": null,
            "inspection_type": "Building Addition",
            "work_description": "REPLACING 50GAL WATER HEATER (0.69 ENERGY FACTOR) IN SAME LOCATION.",
            "inspection_applied_date": null,
            "inspection_status_date": null,
            "inspection_scheduled_date": null,
            "inspection_fees": null,
            "inspection_valuation": null,
            "parcel_id": "063 315004900",
            "master_permit_number": null,
            "comments": "Work Type: Alteration, Job Valuation: 0",
            "inspector_name": "JOHN GERRY",
            "inspector_phone": null,
            "inspection_id": 1260140,
            "contractor_details": null,
            "owner_details": null,
            "applicant_details": null
          },
          {
            "inspection_number": "B2019-03695",
            "inspection_status": null,
            "inspection_type": "Building Alteration",
            "work_description": "Install EV charger in garage",
            "inspection_applied_date": null,
            "inspection_status_date": null,
            "inspection_scheduled_date": "2019-08-30",
            "inspection_fees": "$125.00",
            "inspection_valuation": null,
            "parcel_id": "063 315004900",
            "master_permit_number": null,
            "comments": "Category: Residential, Work Type: Alteration, Job Valuation: 0",
            "inspector_name": "RICK MARTIN",
            "inspector_phone": null,
            "inspection_id": 1260133,
            "contractor_details": null,
            "owner_details": null,
            "applicant_details": null
          }
        ]
      }
    ],
    "metadata": {
      "tx_start_time": "2025-11-03T06:23:47.984603",
      "txn_id": "57281458236245a7b757f9641e8e9302",
      "request": {
        "building_number": "1100",
        "city": "BERKELEY",
        "state": "CA",
        "street_address": "PARK HILLS RD",
        "zip": "94708"
      },
      "total_valuation": 287095.0,
      "count_of_permits": 3,
      "count_of_inspections": 2,
      "response_time": "1.13s"
      }
    }
}

Scenario:- 5
Additional Scenario for Each API

/POST

https://permits.himaintenance.io/search-api/v5/address_search?building_number=&street_address=&city=&state=&zip=

If the requested address is unable to parse
Query Param Value
street_address Non matching address
ciy -
state -
zip -
unit -
Response Body with status code
400
{
    "reference_id": "44b34d2d157f435ba28a52fd8ef78541",
      "request_address": {
          "street_address": "Non matching address",
          "city": -,
          "state": -,
          "zip": -
        },
        "status": "ERROR_IN_PARSING"
        "creation_timestamp": "2024-09-25T05:42:28.231397"

      }

/GET

https://permits.himaintenance.io/search-api/v5/get_status/?reference_id=44b34d2d157f435ba28a52fd8ef78541

If address doesn't exist Or Even if it is valid
Query Param Value
reference_id 44b34d2d157f435ba28a52fd8ef78541
Response Body with status code
200
{
    "address_result": []
      "request_address": {
          "street_address": "4293 CONIFER ST",
          "city": "TALLAHASSEE",
          "state": "FL",
          "zip": "32311"
        },
        "status": "ADDRESS_NOT_FOUND"
  }

If Reference ID is not Valid
Query Param Value
reference_id 44b34d2d157f435ba28a52fd8ef78541
Response Body with status code
400
{
    "status_message": "No record found with the given reference_id."
}

/GET

https://permits.himaintenance.io/search-api/v5/get_permits?address_id=ae3811d2e43a4dfbb8e04291f59e0cd5-P1208600142241

If Address ID is not Valid
Query Param Value
address_id 44b34d2d157f8a52fd8ef78541-P1207300076168
Response Body with status code
400
{
    "address_id": "44b34d2d157f8a52fd8ef78541-P1207300076168"
    "status": "Check inputs, extraction failed."
    "status_code": 400
    "message": "Invalid input. We tried if you have given the reference_id but, no record found with the given reference ID."
}



Audit Service

/GET

Using Tenant ID
http://permits.himaintenance.io/audit-svc/tenanttransactionscount?tenant_id=tenant4

/GET

Using User ID
http://permits.himaintenance.io/audit-svc/usertransactionscount?user_id=user1

/GET

Using Status
http://permits.himaintenance.io/audit-svc/statustransactionscount?status=SUCCESS

/GET

Using Date Range
http://permits.himaintenance.io/audit-svc/transactionscountbyrequesttime?fromDate=2021-05-04&toDate=2021-05-05
Following are unique parameters that can be used
Query Param Value
tenant_id tenant4
user_id user1
status SUCCESS
fromDate 2021-05-04
toDate 2021-05-05
Response Body with status code
200
{"count":28}

/GET

Verifying the service is up
https://permits.himaintenance.io/search-svc/ping
"success"
©2021 by MessyData Inc. All Rights Reserved.