500 trial credits · No credit card required

Shovels Read a saved permit record API

Read the address-resolution record saved with your permit-search property. Get structured JSON through one RealtyCrawl API key.

Get an API key View documentation

Supply property_id in the URL path. Put declared optional selectors and response fields/format in the query string. This operation reads an account-owned retained observation. It does not refresh the source; inspect its collection time and retention limits. Check live capabilities for accepted inputs and availability before running your request.

Shovels API

What can you do with the Read a saved permit record API?

Read the address-resolution record saved with your permit-search property.

Example request

curl --request GET 'https://realtycrawl.dev/v1/properties/prop_shovels_4b825dc642cb6eb9a060e54bf8d69288/records' \
  --header "x-api-key: $REALTYCRAWL_API_KEY" \
  --header 'X-Max-Credits: 1'

import os
import json
import requests

headers = {
  "X-Max-Credits": "1"
}
headers["x-api-key"] = os.environ["REALTYCRAWL_API_KEY"]

response = requests.request("GET", "https://realtycrawl.dev/v1/properties/prop_shovels_4b825dc642cb6eb9a060e54bf8d69288/records",
    headers=headers, timeout=60)
response.raise_for_status()
print(json.dumps(response.json(), indent=2))

const response = await fetch("https://realtycrawl.dev/v1/properties/prop_shovels_4b825dc642cb6eb9a060e54bf8d69288/records", {
  method: "GET",
  headers: {
    "x-api-key": process.env.REALTYCRAWL_API_KEY,
    ...{
      "X-Max-Credits": "1"
    }
  }
});
if (!response.ok) throw new Error(`Request failed: ${response.status}`);
console.log(await response.json());

Parameters

Parameters for Shovels Read a saved permit record API
Parameter	Required	Description
property_id	Yes	property_id
limit	No	One snapshot or newest source entry only;omit for default1.
cursor	No	Continuation is unsupported for this source.
fields	No	Response-only comma-separated field paths relative to data items; up to 32 paths. Source requests and billing are unchanged.
format	No	Response-only export format. JSON retains the envelope; CSV/NDJSON contain data records, with request/credit metadata in headers. Errors stay JSON.

Supply property_id in the URL path. Put declared optional selectors and response fields/format in the query string.

Example response

What does the Shovels Read a saved permit record API return?

The response includes an array of property records in data, plus source outcomes and request metadata. Explore the structure below before making a call.

Illustrative response

{
  "data": [
    {
      "id": "example_shovels_record",
      "record_type": "property_record",
      "event_at": null,
      "jurisdiction": "US-TX",
      "source": {
        "platform": "shovels",
        "provider": "shovels",
        "country": "US",
        "access_class": "licensed_feed",
        "observed_at": "2026-01-01T12:00:00Z",
        "retrieved_at": "2026-01-01T12:00:00Z",
        "native_id": "geo_5500grandlake",
        "url": null
      },
      "fields": {
        "shovels_geo_id": "geo_5500grandlake",
        "permit_window": {
          "from": "2016-11-10",
          "to": "2026-11-10",
          "returned": 1
        },
        "limitations": "Provider permit index resolved from an address match. Filings as indexed by the provider, not a complete permit history."
      }
    }
  ],
  "meta": {
    "request_id": "example_request",
    "schema_version": "1.0.0",
    "generated_at": "2026-01-01T12:00:00Z",
    "completeness": "unknown",
    "sources": [
      {
        "platform": "shovels_permits",
        "status": "success"
      }
    ]
  }
}

Schema example with placeholder values; not a live source result. Actual fields, values, and completeness vary by source and request.

API details

How does the Shovels Read a saved permit record API work?

Send a GET request with your API key and accepted inputs. RealtyCrawl returns structured JSON and preserves the source context for your application.

Method

GET

Response

JSON · CSV · NDJSON

GET /v1/properties/{property_id}/records

Why RealtyCrawl

Why use RealtyCrawl for Shovels Read a saved permit record?

Keep source collection behind a shared interface so you can focus on the product you’re building.

One API key for supported operations across the RealtyCrawl catalog.
Operation-specific source fields returned in a common JSON schema.
Source identifiers, timestamps, and completeness metadata stay with the result.
1 credits per successful call, with failed calls refunded.

Developer first

How do you bring real estate data into your app?

Use familiar HTTP requests, inspect a common schema, and connect the results to the tools your team already uses.

One key, many sources

Use the same credential across supported operations and check capabilities for each source.

Property data with context

Keep currencies, area units, source identifiers, and observation times with your results.

Your language, your workflow

Call the API with cURL, Python, TypeScript, or any backend that can send an HTTP request.

PythonTypeScript{ }cURL

import requests

# Check current source availability before collecting.
response = requests.get(
    'https://realtycrawl.dev/v1/meta/capabilities',
    params={'platform': 'zillow'}
)
response.raise_for_status()
capabilities = response.json()

// Check current source availability before collecting.
const response = await fetch(
  'https://realtycrawl.dev/v1/meta/capabilities?platform=zillow'
);
if (!response.ok) throw new Error('Request failed');
const capabilities = await response.json();

curl 'https://realtycrawl.dev/v1/meta/capabilities?platform=zillow'

import requests

# Check current source availability before collecting.
response = requests.get(
    'https://realtycrawl.dev/v1/meta/capabilities',
    params={'platform': 'redfin'}
)
response.raise_for_status()
capabilities = response.json()

// Check current source availability before collecting.
const response = await fetch(
  'https://realtycrawl.dev/v1/meta/capabilities?platform=redfin'
);
if (!response.ok) throw new Error('Request failed');
const capabilities = await response.json();

curl 'https://realtycrawl.dev/v1/meta/capabilities?platform=redfin'

import requests

# Check current source availability before collecting.
response = requests.get(
    'https://realtycrawl.dev/v1/meta/capabilities',
    params={'platform': 'realtor'}
)
response.raise_for_status()
capabilities = response.json()

// Check current source availability before collecting.
const response = await fetch(
  'https://realtycrawl.dev/v1/meta/capabilities?platform=realtor'
);
if (!response.ok) throw new Error('Request failed');
const capabilities = await response.json();

curl 'https://realtycrawl.dev/v1/meta/capabilities?platform=realtor'

import requests

# Check current source availability before collecting.
response = requests.get(
    'https://realtycrawl.dev/v1/meta/capabilities',
    params={'platform': 'rightmove'}
)
response.raise_for_status()
capabilities = response.json()

// Check current source availability before collecting.
const response = await fetch(
  'https://realtycrawl.dev/v1/meta/capabilities?platform=rightmove'
);
if (!response.ok) throw new Error('Request failed');
const capabilities = await response.json();

curl 'https://realtycrawl.dev/v1/meta/capabilities?platform=rightmove'

import requests

# Check current source availability before collecting.
response = requests.get(
    'https://realtycrawl.dev/v1/meta/capabilities',
    params={'platform': 'idealista'}
)
response.raise_for_status()
capabilities = response.json()

// Check current source availability before collecting.
const response = await fetch(
  'https://realtycrawl.dev/v1/meta/capabilities?platform=idealista'
);
if (!response.ok) throw new Error('Request failed');
const capabilities = await response.json();

curl 'https://realtycrawl.dev/v1/meta/capabilities?platform=idealista'

Capability excerpt · illustrative

{
  "platform": "zillow",
  "operation": "searchPlatformListings",
  "status": "active",
  "geographies": [
    "US"
  ],
  "execution": "sync"
}

{
  "platform": "redfin",
  "operation": "searchPlatformListings",
  "status": "active",
  "geographies": [
    "US"
  ],
  "execution": "sync"
}

{
  "platform": "realtor",
  "operation": "searchPlatformListings",
  "status": "active",
  "geographies": [
    "US"
  ],
  "execution": "sync"
}

{
  "platform": "rightmove",
  "operation": "searchPlatformListings",
  "status": "active",
  "geographies": [
    "GB"
  ],
  "execution": "sync"
}

{
  "platform": "idealista",
  "operation": "searchPlatformListings",
  "status": "active",
  "geographies": [
    "ES"
  ],
  "execution": "sync"
}

ZillowRedfinRealtor.comRightmoveIdealistaBrowse the platform catalog

FAQ

Have a question?
We got answers

Find answers to common questions about Shovels requests, responses, and credits.

How can I try the Shovels Read a saved permit record API?

Create an account for 500 trial credits, check live capabilities for Shovels, and use the example request above with your API key. This operation lists 1 credits per successful call.

What does the Read a saved permit record API return?

The JSON response contains an array of property records in data. The meta object carries request diagnostics and source outcomes. CSV/NDJSON exports contain data records with request and credit metadata in headers.

Where do I put the request parameters?

Supply property_id in the URL path. Put declared optional selectors and response fields/format in the query string.

Is this endpoint available for every market?

Availability is operation-specific. Check /v1/meta/capabilities for the platform’s live status, accepted selectors, and markets. Unavailable requests are not charged.

Is this an official Shovels endpoint?

RealtyCrawl is an independent real estate data API and is not affiliated with Shovels.