Public REST/JSON reference
Rental Comp Price Monitor API
Public BFF API for property comparable rents, market-rate recommendations, market trends, and alert configuration. Part of the Logic Igniter Real Estate & Property Suite.
Access boundary
These examples describe public API calls only. Use the service output to review, score, summarize, analyze, or recommend; do not treat the API reference as permission for an assistant to write, send, publish, charge, schedule, notify, delete, or modify records.
Base URL
https://api.logicigniter.comAuth
Authorization: Bearer YOUR_API_KEYVersion
OpenAPI 3.0.3 · 1.0.0Operations rendered
14
Response models rendered
4
/api/v1/rentalcomp/healthGet Health
Get Health for property comparable rents, market-rate recommendations, market trends, and alert configuration.
Public REST/JSON operation
This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.
Request example
Replace placeholders with your confirmed access key and your own business data.
curl -X GET "https://api.logicigniter.com/api/v1/rentalcomp/health" \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Accept: application/json"
Responses
Successful response
Request validation failed
Missing or invalid bearer token
Subscription or bundle access required
Requested record was not found
Unexpected service error
/api/v1/rentalcomp/customersGet Customers
Get Customers for property comparable rents, market-rate recommendations, market trends, and alert configuration.
Public REST/JSON operation
This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.
Parameters
| Name | In | Type | Notes |
|---|---|---|---|
page_size | query | integer | |
page_token | query | string |
Request example
Replace placeholders with your confirmed access key and your own business data.
curl -X GET "https://api.logicigniter.com/api/v1/rentalcomp/customers" \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Accept: application/json"
Responses
Successful response
Request validation failed
Missing or invalid bearer token
Subscription or bundle access required
Requested record was not found
Unexpected service error
/api/v1/rentalcomp/customersCreate or run Customers
Create or run Customers for property comparable rents, market-rate recommendations, market trends, and alert configuration.
Public REST/JSON operation
This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.
Parameters
| Name | In | Type | Notes |
|---|---|---|---|
page_size | query | integer | |
page_token | query | string |
Request body (required)
Schema: RentalcompResultRequest
Request example
Replace placeholders with your confirmed access key and your own business data.
curl -X POST "https://api.logicigniter.com/api/v1/rentalcomp/customers" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'Responses
Successful response
Request validation failed
Missing or invalid bearer token
Subscription or bundle access required
Requested record was not found
Unexpected service error
/api/v1/rentalcomp/customers/{id}Get Customers/Id
Get Customers/Id for property comparable rents, market-rate recommendations, market trends, and alert configuration.
Public REST/JSON operation
This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.
Parameters
| Name | In | Type | Notes |
|---|---|---|---|
idrequired | path | string |
Request example
Replace placeholders with your confirmed access key and your own business data.
curl -X GET "https://api.logicigniter.com/api/v1/rentalcomp/customers/:id" \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Accept: application/json"
Responses
Successful response
Request validation failed
Missing or invalid bearer token
Subscription or bundle access required
Requested record was not found
Unexpected service error
/api/v1/rentalcomp/customers/{id}Update Customers/Id
Update Customers/Id for property comparable rents, market-rate recommendations, market trends, and alert configuration.
Public REST/JSON operation
This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.
Parameters
| Name | In | Type | Notes |
|---|---|---|---|
idrequired | path | string |
Request body (required)
Schema: RentalcompResultRequest
Request example
Replace placeholders with your confirmed access key and your own business data.
curl -X PUT "https://api.logicigniter.com/api/v1/rentalcomp/customers/:id" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'Responses
Successful response
Request validation failed
Missing or invalid bearer token
Subscription or bundle access required
Requested record was not found
Unexpected service error
/api/v1/rentalcomp/propertiesGet Properties
Get Properties for property comparable rents, market-rate recommendations, market trends, and alert configuration.
Public REST/JSON operation
This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.
Parameters
| Name | In | Type | Notes |
|---|---|---|---|
page_size | query | integer | |
page_token | query | string |
Request example
Replace placeholders with your confirmed access key and your own business data.
curl -X GET "https://api.logicigniter.com/api/v1/rentalcomp/properties" \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Accept: application/json"
Responses
Successful response
Request validation failed
Missing or invalid bearer token
Subscription or bundle access required
Requested record was not found
Unexpected service error
/api/v1/rentalcomp/propertiesCreate or run Properties
Create or run Properties for property comparable rents, market-rate recommendations, market trends, and alert configuration.
Public REST/JSON operation
This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.
Parameters
| Name | In | Type | Notes |
|---|---|---|---|
page_size | query | integer | |
page_token | query | string |
Request body (required)
Schema: RentalcompResultRequest
Request example
Replace placeholders with your confirmed access key and your own business data.
curl -X POST "https://api.logicigniter.com/api/v1/rentalcomp/properties" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'Responses
Successful response
Request validation failed
Missing or invalid bearer token
Subscription or bundle access required
Requested record was not found
Unexpected service error
/api/v1/rentalcomp/properties/{property_id}Get Properties/Property Id
Get Properties/Property Id for property comparable rents, market-rate recommendations, market trends, and alert configuration.
Public REST/JSON operation
This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.
Parameters
| Name | In | Type | Notes |
|---|---|---|---|
property_idrequired | path | string |
Request example
Replace placeholders with your confirmed access key and your own business data.
curl -X GET "https://api.logicigniter.com/api/v1/rentalcomp/properties/:property_id" \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Accept: application/json"
Responses
Successful response
Request validation failed
Missing or invalid bearer token
Subscription or bundle access required
Requested record was not found
Unexpected service error
/api/v1/rentalcomp/properties/{property_id}/compsGet Properties/Property Id/Comps
Get Properties/Property Id/Comps for property comparable rents, market-rate recommendations, market trends, and alert configuration.
Public REST/JSON operation
This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.
Parameters
| Name | In | Type | Notes |
|---|---|---|---|
property_idrequired | path | string |
Request example
Replace placeholders with your confirmed access key and your own business data.
curl -X GET "https://api.logicigniter.com/api/v1/rentalcomp/properties/:property_id/comps" \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Accept: application/json"
Responses
Successful response
Request validation failed
Missing or invalid bearer token
Subscription or bundle access required
Requested record was not found
Unexpected service error
/api/v1/rentalcomp/properties/{property_id}/market-rateGet Properties/Property Id/Market Rate
Get Properties/Property Id/Market Rate for property comparable rents, market-rate recommendations, market trends, and alert configuration.
Public REST/JSON operation
This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.
Parameters
| Name | In | Type | Notes |
|---|---|---|---|
property_idrequired | path | string |
Request example
Replace placeholders with your confirmed access key and your own business data.
curl -X GET "https://api.logicigniter.com/api/v1/rentalcomp/properties/:property_id/market-rate" \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Accept: application/json"
Responses
Successful response
Request validation failed
Missing or invalid bearer token
Subscription or bundle access required
Requested record was not found
Unexpected service error
/api/v1/rentalcomp/properties/{property_id}/market-trendGet Properties/Property Id/Market Trend
Get Properties/Property Id/Market Trend for property comparable rents, market-rate recommendations, market trends, and alert configuration.
Public REST/JSON operation
This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.
Parameters
| Name | In | Type | Notes |
|---|---|---|---|
property_idrequired | path | string |
Request example
Replace placeholders with your confirmed access key and your own business data.
curl -X GET "https://api.logicigniter.com/api/v1/rentalcomp/properties/:property_id/market-trend" \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Accept: application/json"
Responses
Successful response
Request validation failed
Missing or invalid bearer token
Subscription or bundle access required
Requested record was not found
Unexpected service error
/api/v1/rentalcomp/properties/{property_id}/recommendationGet Properties/Property Id/Recommendation
Get Properties/Property Id/Recommendation for property comparable rents, market-rate recommendations, market trends, and alert configuration.
Public REST/JSON operation
This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.
Parameters
| Name | In | Type | Notes |
|---|---|---|---|
property_idrequired | path | string |
Request example
Replace placeholders with your confirmed access key and your own business data.
curl -X GET "https://api.logicigniter.com/api/v1/rentalcomp/properties/:property_id/recommendation" \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Accept: application/json"
Responses
Successful response
Request validation failed
Missing or invalid bearer token
Subscription or bundle access required
Requested record was not found
Unexpected service error
/api/v1/rentalcomp/alertsGet Alerts
Get Alerts for property comparable rents, market-rate recommendations, market trends, and alert configuration.
Public REST/JSON operation
This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.
Parameters
| Name | In | Type | Notes |
|---|---|---|---|
page_size | query | integer | |
page_token | query | string |
Request example
Replace placeholders with your confirmed access key and your own business data.
curl -X GET "https://api.logicigniter.com/api/v1/rentalcomp/alerts" \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Accept: application/json"
Responses
Successful response
Request validation failed
Missing or invalid bearer token
Subscription or bundle access required
Requested record was not found
Unexpected service error
/api/v1/rentalcomp/alerts/configUpdate Alerts/Config
Update Alerts/Config for property comparable rents, market-rate recommendations, market trends, and alert configuration.
Public REST/JSON operation
This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.
Request body (required)
Schema: RentalcompResultRequest
Request example
Replace placeholders with your confirmed access key and your own business data.
curl -X PUT "https://api.logicigniter.com/api/v1/rentalcomp/alerts/config" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'Responses
Successful response
Request validation failed
Missing or invalid bearer token
Subscription or bundle access required
Requested record was not found
Unexpected service error
Data models
RentalcompResultRequest
| Field | Type | Notes |
|---|---|---|
source_idrequired | string | |
workspace_id | string | |
notes | string | |
filters | object |
RentalcompResult
| Field | Type | Notes |
|---|---|---|
idrequired | string | Example: "rec_1042" |
workspace_id | string | Example: "workspace_123" |
statusrequired | enum(pending | active | completed | failed) | One of: pending, active, completed, failed |
summaryrequired | string | |
score | number (double) | |
signals | array<string> | |
created_at | string (date-time) | |
updated_at | string (date-time) |
RentalcompResultResponse
| Field | Type | Notes |
|---|---|---|
datarequired | RentalcompResult | |
items | array<RentalcompResult> | |
next_page_token | string |
ErrorResponse
| Field | Type | Notes |
|---|---|---|
coderequired | string | |
messagerequired | string | |
request_id | string |