Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to Zillow

Scalekit connector
Open markdown

The Zillow connector lets your AI agent act in each user's Zillow account. Each user connects their own Zillow access token once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 23 tools.

Tools
23
What they doRead · write · destructive
23 · 0 · 023 read0 write0 destructive
Users sign in with

Setup

  1. Install the SDK

    Terminal window
    npm install @scalekit-sdk/node dotenv
  2. Set your credentials

    Add your Scalekit credentials to your .env file. Find values in app.scalekit.com > Developers > API Credentials.

    .env
    SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
    SCALEKIT_CLIENT_ID=<your-client-id>
    SCALEKIT_CLIENT_SECRET=<your-client-secret>
  3. Create the Zillow connection

    In AgentKit > Connections, create a Zillow connection. The name you give it is the connection_name your code passes. See Configure connections.

  4. Authorize a user and make your first call

    quickstart.mts
    import { ScalekitClient } from '@scalekit-sdk/node'
    import 'dotenv/config'
    import { createInterface } from 'node:readline/promises'
    const scalekit = new ScalekitClient(
    process.env.SCALEKIT_ENVIRONMENT_URL,
    process.env.SCALEKIT_CLIENT_ID,
    process.env.SCALEKIT_CLIENT_SECRET,
    )
    const actions = scalekit.actions
    const connector = 'zillow'
    const identifier = 'user_123'
    // Generate an authorization link for the user
    const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
    console.log('Authorize Zillow:', link)
    const rl = createInterface({ input: process.stdin, output: process.stdout })
    await rl.question('Press Enter after authorizing...')
    rl.close()
    // Make your first call
    const result = await actions.executeTool({
    connector,
    identifier,
    toolName: 'zillow_assessments_search',
    toolInput: {},
    })
    console.log(result)
    Terminal window
    npx tsx quickstart.mts

    Each user opens the link once and enters their Zillow credentials there. See Authorize a user for the full flow and statuses.

Tools

Pass the exact name to execute_tool
Try in PlaygroundRequest a tool
  • zillow_datasets_listList the Bridge datasets your access token is approved for, such as MLS listing feeds.Read-only

    List Datasets

    List the Bridge datasets your access token is approved for, such as MLS listing feeds. Returns datasets with their dataset IDs and names. Use this first to get the dataset_id for the MLS listing, member, office and open house tools.

    Inputs

    This tool takes no inputs.

  • zillow_econ_cuts_listList the data cuts in Zillow economic research data: the home-type, price-tier and adjustment combinations each metric is published for.Read-only

    List Economic Cuts

    List the data cuts in Zillow economic research data: the home-type, price-tier and adjustment combinations each metric is published for. Returns cuts with cutTypeKey, metricTypeKey, regionTypeID, timePeriodTypeKey, homeTypeMap, homeTypeRangeMap and adjustments. Use this to choose the cut_type_key for zillow_market_reports_search.

    Inputs

    cut_type_keystring
    Cut key to look up. Example: uc_sfrcondo
    fieldsstring
    Comma-separated list of response fields to return, to shrink the response. Leave empty to return every field. Example: cutTypeKey,metricTypeKey,regionTypeID,timePeriodTypeKey
    limitinteger
    Maximum number of records to return in one page, from 1 to 200. The API returns 10 when this is omitted. Example: 50
    metric_type_keystring
    Metric key to list cuts for. Example: zhvi
    offsetinteger
    Number of records to skip, for paging. Add the previous limit to page forward; set sort_by too so pages do not repeat records. Example: 200
    region_type_idinteger
    Region type ID the cut applies to. Example: 102
  • zillow_econ_regions_listList the regions covered by Zillow economic research data, filtered by state, name or region ID.Read-only

    List Economic Regions

    List the regions covered by Zillow economic research data, filtered by state, name or region ID. Returns regions with regionID, region name, regionState, regionCity, regionCounty, regionMetro and FIPS codes. Use this to find the regionID for zillow_market_reports_search.

    Inputs

    fieldsstring
    Comma-separated list of response fields to return, to shrink the response. Leave empty to return every field. Example: regionID,region,regionState,regionCounty,regionMetro
    limitinteger
    Maximum number of records to return in one page, from 1 to 200. The API returns 10 when this is omitted. Example: 50
    offsetinteger
    Number of records to skip, for paging. Add the previous limit to page forward; set sort_by too so pages do not repeat records. Example: 200
    regionstring
    Region name to match exactly. Example: Austin
    region_idinteger
    Zillow region ID. Example: 394355
    region_statestring
    Two-letter state abbreviation of the region. Example: TX
    state_code_fipsstring
    Two-digit state FIPS code. Example: 48
  • zillow_econ_types_listList the metric, region, time-period and other type keys used in Zillow economic research data, with their descriptions.Read-only

    List Economic Types

    List the metric, region, time-period and other type keys used in Zillow economic research data, with their descriptions. Returns types with key, description, metadataType and allowed values. Use this to explain a key in a market report or to choose the metric_type_key for zillow_market_reports_search.

    Inputs

    fieldsstring
    Comma-separated list of response fields to return, to shrink the response. Leave empty to return every field. Example: key,description,metadataType
    keystring
    Type key to look up, such as a metricTypeKey from a market report. Example: zhvi
    limitinteger
    Maximum number of records to return in one page, from 1 to 200. The API returns 10 when this is omitted. Example: 50
    metadata_typestring
    Kind of type to list, as in the metadataType field. Example: metricType
    offsetinteger
    Number of records to skip, for paging. Add the previous limit to page forward; set sort_by too so pages do not repeat records. Example: 200
  • zillow_lookups_listList the allowed values (lookups) of enumerated fields in one MLS dataset, such as StandardStatus or PropertyType.Read-only

    List MLS Lookups

    List the allowed values (lookups) of enumerated fields in one MLS dataset, such as StandardStatus or PropertyType. Returns lookups with LookupName, LookupValue, StandardLookupValue and LegacyODataValue. Use this to build a valid filter for zillow_properties_search. Run zillow_datasets_list first to get the dataset ID.

    Inputs

    dataset_idstringrequired
    Bridge dataset ID of the MLS to query. Get it from zillow_datasets_list (the datasets your token is approved for). Example: test
    filterstring
    OData $filter expression. Operators: eq, ne, gt, lt, ge, le, and, or, not; string values go in single quotes. Filter on LookupName to get the allowed values of one field. Example: LookupName eq 'StandardStatus'
    orderbystring
    Field to sort by followed by asc or desc ($orderby). Set this when paging so pages do not repeat records. Example: LookupName asc
    selectstring
    Comma-separated list of fields to return ($select). Leave empty to return every field. Example: LookupName,LookupValue,StandardLookupValue
    skipinteger
    Number of records to skip ($skip), for paging. Add the previous top to page forward, and set order_by. Example: 200
    topinteger
    Maximum number of records to return ($top), from 1 to 200. The API returns 10 when this is omitted. Example: 50
  • zillow_member_getGet one MLS member (agent) by MemberKey.Read-only

    Get MLS Member

    Get one MLS member (agent) by MemberKey. Returns the member's name, contact details, MemberMlsId, status, designations and OfficeKey. Use this when you have a MemberKey, such as a listing's ListAgentKey. Use zillow_members_search to find members. Run zillow_members_search or zillow_property_get first to get the MemberKey.

    Inputs

    dataset_idstringrequired
    Bridge dataset ID of the MLS to query. Get it from zillow_datasets_list (the datasets your token is approved for). Example: test
    member_keystringrequired
    MemberKey of the agent, from zillow_members_search or a listing's ListAgentKey. Example: 3yd-ACTRIS-123456
    selectstring
    Comma-separated list of fields to return ($select). Leave empty to return every field. Example: MemberKey,MemberFullName,MemberEmail,MemberMlsId,OfficeKey