building_permits_series

Pack: building-permits · Connect: https://pipeworx.io/mcp (see Connect below for a single-pack URL)

No MCP client? Call it directly: GET https://gateway.pipeworx.io/v1/tools/building_permits_series for the schema, then POST the same URL with its arguments for the data.

Time series of US residential building permits for one county, place or state from the US Census Bureau Building Permits Survey, one period_type per call (monthly, year_to_date or annual), oldest first, with optional from/to bounds. Each row carries period, file_vintage and revisions so a figure that moved after late reports is visible. Counties and states: use FIPS (county 5 digits, state 2 digits). Places: use place_id from building_permits_place. Connecticut county FIPS 09001-09015 and planning-region FIPS 09110-09190 are different geographies and are never joined: a series stops where the publisher switched. Monthly and year_to_date data start 2020-01; annual county and state 2000, annual place 2010.

Parameters

NameTypeRequiredDescription
levelstringyesGeography level.
idstringyescounty: 5-digit FIPS; place: 8-digit place_id; state: 2-digit FIPS, postal abbreviation or name (or US for the national total).
fromstringnoFirst period (YYYY-MM or YYYY).
tostringnoLast period (YYYY-MM or YYYY).
limitnumbernoMax rows (1-400, default 120).

Example call

Arguments

{
  "level": "county",
  "id": "48201",
  "period_type": "monthly",
  "from": "2024-01",
  "to": "2026-09"
}

curl

curl -X POST https://gateway.pipeworx.io/building-permits/mcp \
  -H 'Content-Type: application/json' \
  -d '{"jsonrpc":"2.0","id":1,"method":"tools/call","params":{"name":"building_permits_series","arguments":{"level":"county","id":"48201","period_type":"monthly","from":"2024-01","to":"2026-09"}}}'

TypeScript (@pipeworx/sdk)

import { Pipeworx } from '@pipeworx/sdk';
const pipeworx = new Pipeworx();

const result = await pipeworx.call('building_permits_series', {
  "level": "county",
  "id": "48201",
  "period_type": "monthly",
  "from": "2024-01",
  "to": "2026-09"
});

Response shape

FieldTypeDescription
geographyobject
period_typestring
first_periodstring
last_periodstring
countnumber
rowsarray
notesarray
sourcestring
licencestring
data_as_ofstring
refreshed_atstring
coveragestring
Full JSON Schema
{
  "type": "object",
  "properties": {
    "geography": {
      "type": "object",
      "properties": {
        "level": {
          "type": "string"
        },
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "state_fips": {
          "type": "string"
        },
        "state": {
          "type": "string"
        },
        "county_fips": {
          "type": "string"
        }
      },
      "additionalProperties": true
    },
    "period_type": {
      "type": "string"
    },
    "first_period": {
      "type": "string"
    },
    "last_period": {
      "type": "string"
    },
    "count": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "period_type": {
            "type": "string"
          },
          "period": {
            "type": "string"
          },
          "file_vintage": {
            "type": "string"
          },
          "revisions": {
            "type": "number"
          },
          "estimated_including_imputation": {
            "type": "object",
            "properties": {
              "total": {
                "type": "object",
                "properties": {
                  "buildings": {
                    "type": "number"
                  },
                  "units": {
                    "type": "number"
                  },
                  "value_usd": {
                    "type": "number"
                  }
                },
                "additionalProperties": true
              },
              "by_structure": {
                "type": "object",
                "properties": {
                  "1_unit": {
                    "type": "object",
                    "properties": {
                      "buildings": {
                        "type": "number"
                      },
                      "units": {
                        "type": "number"
                      },
                      "value_usd": {
                        "type": "number"
                      }
                    },
                    "additionalProperties": true
                  },
                  "2_units": {
                    "type": "object",
                    "properties": {
                      "buildings": {
                        "type": "number"
                      },
                      "units": {
                        "type": "number"
                      },
                      "value_usd": {
                        "type": "number"
                      }
                    },
                    "additionalProperties": true
                  },
                  "3_4_units": {
                    "type": "object",
                    "properties": {
                      "buildings": {
                        "type": "number"
                      },
                      "units": {
                        "type": "number"
                      },
                      "value_usd": {
                        "type": "number"
                      }
                    },
                    "additionalProperties": true
                  },
                  "5_plus_units": {
                    "type": "object",
                    "properties": {
                      "buildings": {
                        "type": "number"
                      },
                      "units": {
                        "type": "number"
                      },
                      "value_usd": {
                        "type": "number"
                      }
                    },
                    "additionalProperties": true
                  }
                },
                "additionalProperties": true
              }
            },
            "additionalProperties": true
          },
          "reported_only": {
            "type": "object",
            "properties": {
              "total": {
                "type": "object",
                "properties": {
                  "buildings": {
                    "type": "number"
                  },
                  "units": {
                    "type": "number"
                  },
                  "value_usd": {
                    "type": "number"
                  }
                },
                "additionalProperties": true
              },
              "by_structure": {
                "type": "object",
                "properties": {
                  "1_unit": {
                    "type": "object",
                    "properties": {
                      "buildings": {
                        "type": "number"
                      },
                      "units": {
                        "type": "number"
                      },
                      "value_usd": {
                        "type": "number"
                      }
                    },
                    "additionalProperties": true
                  },
                  "2_units": {
                    "type": "object",
                    "properties": {
                      "buildings": {
                        "type": "number"
                      },
                      "units": {
                        "type": "number"
                      },
                      "value_usd": {
                        "type": "number"
                      }
                    },
                    "additionalProperties": true
                  },
                  "3_4_units": {
                    "type": "object",
                    "properties": {
                      "buildings": {
                        "type": "number"
                      },
                      "units": {
                        "type": "number"
                      },
                      "value_usd": {
                        "type": "number"
                      }
                    },
                    "additionalProperties": true
                  },
                  "5_plus_units": {
                    "type": "object",
                    "properties": {
                      "buildings": {
                        "type": "number"
                      },
                      "units": {
                        "type": "number"
                      },
                      "value_usd": {
                        "type": "number"
                      }
                    },
                    "additionalProperties": true
                  }
                },
                "additionalProperties": true
              }
            },
            "additionalProperties": true
          },
          "imputed_units": {
            "type": "number"
          },
          "imputed_value_usd": {
            "type": "number"
          }
        },
        "additionalProperties": true
      }
    },
    "notes": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "source": {
      "type": "string"
    },
    "licence": {
      "type": "string"
    },
    "data_as_of": {
      "type": "string"
    },
    "refreshed_at": {
      "type": "string"
    },
    "coverage": {
      "type": "string"
    }
  },
  "additionalProperties": true
}

Connect

Add this to your MCP client config — every tool in the catalog, including this one — or use one-click install buttons:

{
  "mcpServers": {
    "pipeworx": {
      "url": "https://pipeworx.io/mcp"
    }
  }
}
Connect to just the building-permits pack
{
  "mcpServers": {
    "building-permits": {
      "url": "https://gateway.pipeworx.io/building-permits/mcp"
    }
  }
}

See Getting Started for client-specific install steps.

Regenerated from source · build November 20, 2026