{"openapi":"3.1.0","info":{"title":"MarketCheck (BYOK) API","version":"0.1.0","description":"MarketCheck (BYOK) lets an AI assistant read your own MarketCheck data through the MarketCheck API with a key you supply (MarketCheck API key). Read-only: 8 tools (search_active_inventory, get_listing, decode_vin, get_market_days_supply, get_sales_statistics, list_popular_cars, search_oem_incentives, autocomplete_inventory_terms). The BYOK key travels with each request, is used for that one call...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-marketcheck.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-marketcheck/docs"},"termsOfService":"https://connectorbay.com/byok-marketcheck/terms"},"servers":[{"url":"https://byok-marketcheck.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-marketcheck/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/search_active_inventory":{"post":{"operationId":"search_active_inventory","summary":"Search active dealer car listings in the US and Canada by place, radius, make, model, year, price, mileage and condition","description":"Search active dealer car listings in the US and Canada by place, radius, make, model, year, price, mileage and condition; returns price, mileage, days on market, dealer and build details. Calls count against your MarketCheck plan. Use for \"Find used Toyota RAV4s under 30000 within 25 miles of 90210\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"zip":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"Five-digit ZIP code for a radius search.","title":"Zip"},"radius":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"Radius in miles around zip or latitude and longitude (the upper limit depends on your plan).","title":"Radius"},"latitude":{"anyOf":[{"type":"number"},{"type":"null"}],"default":null,"description":"Latitude of the search centre.","title":"Latitude"},"longitude":{"anyOf":[{"type":"number"},{"type":"null"}],"default":null,"description":"Longitude of the search centre.","title":"Longitude"},"country":{"anyOf":[{"enum":["us","ca","all"],"type":"string"},{"type":"null"}],"default":null,"description":"Market: us, ca or all (the service defaults to us).","title":"Country"},"state":{"anyOf":[{"maxLength":2,"type":"string"},{"type":"null"}],"default":null,"description":"Two-letter US state or Canadian province code.","title":"State"},"city":{"anyOf":[{"maxLength":80,"type":"string"},{"type":"null"}],"default":null,"description":"City name.","title":"City"},"year":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Model year; several separated by commas.","title":"Year"},"year_range":{"anyOf":[{"maxLength":9,"type":"string"},{"type":"null"}],"default":null,"description":"Model year range as min-max, for example 2018-2022.","title":"Year Range"},"make":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Make; several separated by commas.","title":"Make"},"model":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Model; several separated by commas.","title":"Model"},"trim":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Trim; several separated by commas.","title":"Trim"},"vin":{"anyOf":[{"maxLength":17,"type":"string"},{"type":"null"}],"default":null,"description":"Exact VIN.","title":"Vin"},"body_type":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Body type such as SUV or Sedan.","title":"Body Type"},"fuel_type":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Fuel type such as Electric or Hybrid.","title":"Fuel Type"},"drivetrain":{"anyOf":[{"maxLength":20,"type":"string"},{"type":"null"}],"default":null,"description":"Drivetrain such as AWD or FWD.","title":"Drivetrain"},"transmission":{"anyOf":[{"maxLength":20,"type":"string"},{"type":"null"}],"default":null,"description":"Transmission such as Automatic.","title":"Transmission"},"car_type":{"anyOf":[{"enum":["new","used","certified"],"type":"string"},{"type":"null"}],"default":null,"description":"Condition: new, used or certified.","title":"Car Type"},"price_range":{"anyOf":[{"maxLength":20,"type":"string"},{"type":"null"}],"default":null,"description":"Price range as min-max, for example 10000-30000.","title":"Price Range"},"miles_range":{"anyOf":[{"maxLength":20,"type":"string"},{"type":"null"}],"default":null,"description":"Mileage range as min-max, for example 0-60000.","title":"Miles Range"},"carfax_1_owner":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True for one-owner vehicles.","title":"Carfax 1 Owner"},"carfax_clean_title":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True for clean-title vehicles.","title":"Carfax Clean Title"},"sort_by":{"anyOf":[{"maxLength":20,"type":"string"},{"type":"null"}],"default":null,"description":"Sort field, for example price, miles, dist, dom_active or last_seen.","title":"Sort By"},"sort_order":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":null,"description":"asc or desc (the service defaults to asc).","title":"Sort Order"},"rows":{"anyOf":[{"maximum":50,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"Listings per page (1 to 50).","title":"Rows"},"start":{"anyOf":[{"maximum":100000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Offset of the first listing, for paging (limited by your plan).","title":"Start"}},"title":"search_active_inventoryArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_listing":{"post":{"operationId":"get_listing","summary":"Get one dealer car listing by its MarketCheck listing id: price, price change, mileage, days on market, seller, build an","description":"Get one dealer car listing by its MarketCheck listing id: price, price change, mileage, days on market, seller, build and options. Calls count against your MarketCheck plan. Use for \"Show MarketCheck listing 1FTFW1ET5DFC10312-abc123\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"listing_id":{"description":"MarketCheck listing id (case-sensitive), from search_active_inventory.","maxLength":80,"title":"Listing Id","type":"string"}},"required":["listing_id"],"title":"get_listingArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/decode_vin":{"post":{"operationId":"decode_vin","summary":"Decode a VIN into year, make, model, trim, body, drivetrain, fuel, engine, dimensions and fuel economy. Calls count agai","description":"Decode a VIN into year, make, model, trim, body, drivetrain, fuel, engine, dimensions and fuel economy. Calls count against your MarketCheck plan. Use for \"What vehicle is VIN 1FTFW1ET5DFC10312\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"vin":{"description":"17-character vehicle identification number.","maxLength":17,"title":"Vin","type":"string"}},"required":["vin"],"title":"decode_vinArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_market_days_supply":{"post":{"operationId":"get_market_days_supply","summary":"Get the market days supply for a vehicle (active cars divided by recent daily sales) with the active count and the numbe","description":"Get the market days supply for a vehicle (active cars divided by recent daily sales) with the active count and the number sold in the last 45 days. Calls count against your MarketCheck plan. Use for \"What is the market days supply of 2022 Honda CR-V in ZIP 94025\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"vin":{"anyOf":[{"maxLength":17,"type":"string"},{"type":"null"}],"default":null,"description":"VIN to base the match on.","title":"Vin"},"ymmt":{"anyOf":[{"maxLength":120,"type":"string"},{"type":"null"}],"default":null,"description":"Year|make|model|trim joined by pipes, for example 2022|honda|cr-v|ex.","title":"Ymmt"},"year":{"anyOf":[{"maxLength":4,"type":"string"},{"type":"null"}],"default":null,"description":"Model year.","title":"Year"},"make":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Vehicle make.","title":"Make"},"model":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Vehicle model.","title":"Model"},"trim":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Vehicle trim.","title":"Trim"},"zip":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"Five-digit ZIP code for a local figure.","title":"Zip"},"radius":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"Radius in miles around zip.","title":"Radius"},"state":{"anyOf":[{"maxLength":2,"type":"string"},{"type":"null"}],"default":null,"description":"Two-letter US state or Canadian province code.","title":"State"},"car_type":{"anyOf":[{"enum":["new","used","certified"],"type":"string"},{"type":"null"}],"default":null,"description":"Condition: new, used or certified.","title":"Car Type"},"country":{"anyOf":[{"enum":["us","ca","all"],"type":"string"},{"type":"null"}],"default":null,"description":"Market: us, ca or all (the service defaults to us).","title":"Country"}},"title":"get_market_days_supplyArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_sales_statistics":{"post":{"operationId":"get_sales_statistics","summary":"Get inferred sales statistics (count, price, mileage and days-on-market distributions) for a make, make-model, year-make","description":"Get inferred sales statistics (count, price, mileage and days-on-market distributions) for a make, make-model, year-make-model, trim or VIN; give at least one of make, mm, ymm, ymmt or vin. Calls count against your MarketCheck plan. Use for \"What do used Ford F-150s typically sell for in Texas\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"make":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Make, for example Toyota.","title":"Make"},"mm":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Make and model joined by a pipe, for example ford|f-150.","title":"Mm"},"ymm":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Year, make and model joined by pipes, for example 2015|ford|f-150.","title":"Ymm"},"ymmt":{"anyOf":[{"maxLength":140,"type":"string"},{"type":"null"}],"default":null,"description":"Year, make, model and trim joined by pipes.","title":"Ymmt"},"vin":{"anyOf":[{"maxLength":17,"type":"string"},{"type":"null"}],"default":null,"description":"VIN, converted to a taxonomy VIN.","title":"Vin"},"state":{"anyOf":[{"maxLength":2,"type":"string"},{"type":"null"}],"default":null,"description":"Two-letter US state or Canadian province code.","title":"State"},"city_state":{"anyOf":[{"maxLength":80,"type":"string"},{"type":"null"}],"default":null,"description":"City and state joined by a pipe, for example jacksonville|FL (takes precedence over state).","title":"City State"},"car_type":{"anyOf":[{"enum":["new","used"],"type":"string"},{"type":"null"}],"default":null,"description":"new or used (the service defaults to used).","title":"Car Type"},"country":{"anyOf":[{"enum":["us","ca","all"],"type":"string"},{"type":"null"}],"default":null,"description":"Market: us, ca or all (the service defaults to us).","title":"Country"}},"title":"get_sales_statisticsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_popular_cars":{"post":{"operationId":"list_popular_cars","summary":"List the most common makes and models in current inventory for a market with price, mileage and days-on-market statistic","description":"List the most common makes and models in current inventory for a market with price, mileage and days-on-market statistics (up to 50 rows nationally or per state, 25 per city). Calls count against your MarketCheck plan. Use for \"Which used cars are most common in Florida right now\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"car_type":{"description":"new or used.","enum":["new","used"],"title":"Car Type","type":"string"},"state":{"anyOf":[{"maxLength":2,"type":"string"},{"type":"null"}],"default":null,"description":"Two-letter US state or Canadian province code.","title":"State"},"city_state":{"anyOf":[{"maxLength":80,"type":"string"},{"type":"null"}],"default":null,"description":"City and state joined by a pipe, for example Miami|FL (takes precedence over state).","title":"City State"},"country":{"anyOf":[{"enum":["us","ca","all"],"type":"string"},{"type":"null"}],"default":null,"description":"Market: us, ca or all (the service defaults to us).","title":"Country"}},"required":["car_type"],"title":"list_popular_carsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/search_oem_incentives":{"post":{"operationId":"search_oem_incentives","summary":"Search manufacturer incentive offers (cash back, APR, lease deals) for a make around a ZIP code, with offer type, amount","description":"Search manufacturer incentive offers (cash back, APR, lease deals) for a make around a ZIP code, with offer type, amounts, term and validity dates. Calls count against your MarketCheck plan. Use for \"What incentives does Toyota offer in ZIP 90210\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"make":{"description":"Manufacturer name (case-insensitive), for example Toyota.","maxLength":40,"title":"Make","type":"string"},"zip":{"description":"ZIP code used for regional targeting.","maxLength":10,"title":"Zip","type":"string"},"model":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Model to narrow the offers.","title":"Model"},"year":{"anyOf":[{"maxLength":4,"type":"string"},{"type":"null"}],"default":null,"description":"Model year.","title":"Year"},"offer_type":{"anyOf":[{"maxLength":20,"type":"string"},{"type":"null"}],"default":null,"description":"Offer type filter.","title":"Offer Type"},"rows":{"anyOf":[{"maximum":50,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"Offers per page (service default 10).","title":"Rows"},"start":{"anyOf":[{"maximum":10000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Offset of the first offer.","title":"Start"}},"required":["make","zip"],"title":"search_oem_incentivesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/autocomplete_inventory_terms":{"post":{"operationId":"autocomplete_inventory_terms","summary":"Suggest values (up to 50) for a field such as make, model, trim or ymm from the live inventory, to build valid filters f","description":"Suggest values (up to 50) for a field such as make, model, trim or ymm from the live inventory, to build valid filters for search_active_inventory. Calls count against your MarketCheck plan. Use for \"Which models start with 'camr' in current inventory\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"field":{"description":"Field to complete.","enum":["ymm","mm","make","model","trim","body_type","body_subtype","vehicle_type","transmission","drivetrain","fuel_type","exterior_color","interior_color","engine","engine_size","engine_block","state","city"],"title":"Field","type":"string"},"input":{"description":"Text typed so far.","maxLength":60,"title":"Input","type":"string"},"make":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Make to narrow the suggestions.","title":"Make"},"car_type":{"anyOf":[{"enum":["new","used","certified"],"type":"string"},{"type":"null"}],"default":null,"description":"Condition: new, used or certified.","title":"Car Type"},"year":{"anyOf":[{"maxLength":4,"type":"string"},{"type":"null"}],"default":null,"description":"Model year to narrow the suggestions.","title":"Year"},"country":{"anyOf":[{"enum":["us","ca","all"],"type":"string"},{"type":"null"}],"default":null,"description":"Market: us, ca or all (the service defaults to us).","title":"Country"},"term_counts":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True to return each term with its listing count.","title":"Term Counts"}},"required":["field","input"],"title":"autocomplete_inventory_termsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}