{
  "opencollection": "1.0.0",
  "info": {
    "name": "Shovels Addresses API",
    "version": "v2"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "X-API-Key",
      "value": "{{X-API-Key}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Addresses",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Search Addresses",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.shovels.ai/v2/addresses/search",
            "params": [
              {
                "name": "q",
                "value": "",
                "type": "query",
                "description": "The text to search for in address fields"
              },
              {
                "name": "cursor",
                "value": "",
                "type": "query",
                "description": "Pagination cursor"
              },
              {
                "name": "size",
                "value": "",
                "type": "query",
                "description": "Number of results per page (1-100, default 50)"
              }
            ]
          },
          "docs": "Searches for addresses that have at least one associated permit. Results are ordered by relevance and in USPS notation."
        },
        {
          "info": {
            "name": "Get Address Metrics Current",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.shovels.ai/v2/addresses/:geo_id/metrics/current",
            "params": [
              {
                "name": "geo_id",
                "value": "",
                "type": "path",
                "description": "Address geo_id"
              }
            ]
          },
          "docs": "Returns current metrics for a specific address."
        },
        {
          "info": {
            "name": "Get Address Metrics Monthly",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.shovels.ai/v2/addresses/:geo_id/metrics/monthly",
            "params": [
              {
                "name": "geo_id",
                "value": "",
                "type": "path",
                "description": "Address geo_id"
              }
            ]
          },
          "docs": "Returns monthly metrics for a specific address."
        },
        {
          "info": {
            "name": "Get Address Residents",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.shovels.ai/v2/addresses/:geo_id/residents",
            "params": [
              {
                "name": "geo_id",
                "value": "",
                "type": "path",
                "description": "Address geo_id"
              },
              {
                "name": "cursor",
                "value": "",
                "type": "query",
                "description": "Pagination cursor"
              },
              {
                "name": "size",
                "value": "",
                "type": "query",
                "description": "Number of results per page"
              }
            ]
          },
          "docs": "Retrieves resident information for a given address."
        }
      ]
    }
  ],
  "bundled": true
}