api---alerts

Search alerts (v1)

Returns paginated list of alerts (by requested parameters) for currently authenticated user.

post/api/v1/listing-alerts/search

Request

  • Base URL: https://api.casafari.com
  • URL: https://api.casafari.com/api/v1/listing-alerts/search
  • Auth: HTTP bearer

Query parameters

limitinteger

Number of results to return per page.

offsetinteger

The initial index from which to return the results.

order_by'alert_date' | '-alert_date' | 'alert_id' | '-alert_id' | 'created_at' | '-created_at' | 'updated_at' | '-updated_at'

The field by which to sort the results.

alert_subtype'new' | 'price_up' | 'price_down' | 'reserved' | 'delisted' | 'sold'

Get only alerts of the specific subtype.<br/>Invalid values are ignored. <br/><strong>This field is deprecated and will be removed in the next major update.</strong><br/><strong>Please, use alert_subtypes field in the body parameters instead.</strong>

Request body

operation'sale' | 'rent' required

Operation type.

location_idsinteger[]

List of location IDs, as returned by the POST /api/v1/references/locations endpoint.

typesstring[]

<br>Country availability per type is available at the GET /api/v1/references/types endpoint.<br><br>Property types by type groups:<br/><strong>apartment:</strong> penthouse, dachgeschosswohnung, erdgeschosswohnung, apartment, etagenwohnung, studio, duplex<br/><strong>house:</strong> townhouse, reihenmittelhaus, landwirtschaftliche_betriebe, country_house, family_house (<span style="color:red">DEPRECATED</span>), villa, palace, chalet, zweifamilienhaus, country_estate, reihenendhaus, reihenhaus, bungalow, einfamilienhaus, house<br/><strong>room:</strong> room<br/><strong>building:</strong> office_building, apartment_building, mix_use_building<br/><strong>investment:</strong> retail, hotel, warehouse, office, restaurant, industrial, other_commercial, werkstatt<br/><strong>plot:</strong> rural_plot, urban_plot, plot (<span style="color:red">DEPRECATED</span>)<br/><strong>other:</strong> garage, other, parking

conditionsstring[]

Property conditions, as returned by the GET /api/v1/references/conditions endpoint.

alert_date_fromstring date

Start date (in the format YYYY-MM-DD) of the period for alerts of interest.

alert_date_tostring date

End date (in the format YYYY-MM-DD) of the period for alerts of interest.

created_at_fromstring date-time

Start date and time (in the format YYYY-MM-DDTHH:mm:ss) to filter alerts by their creation in the database (UTC). Useful for incremental sync to avoid fetching already fetched data.

created_at_tostring date-time

End date and time (in the format YYYY-MM-DDTHH:mm:ss) to filter alerts by their creation in the database (UTC). Useful for incremental sync to avoid fetching already fetched data.

created_at_with_photos_fromstring date-time

Start date and time (in the format YYYY-MM-DDTHH:mm:ss) to filter alerts by their creation in the database (UTC), only including alerts for which photo processing has been completed. Use it to fetch alerts with already assigned photos. Note: Some alerts may still not have photos if the original listing did not include any.

created_at_with_photos_tostring date-time

End date and time (in the format YYYY-MM-DDTHH:mm:ss) to filter alerts by their creation in the database (UTC), only including alerts for which photo processing has been completed. Use it to fetch alerts with already assigned photos. Note: Some alerts may still not have photos if the original listing did not include any.

statusesstring[]

Current status of the listing.

price_frominteger

Minimum price value.

price_tointeger

Maximum price value.

price_per_sqm_frominteger

Minimum value for price per square meter.

price_per_sqm_tointeger

Maximum value for price per square meter.

bedrooms_frominteger

Minimum number of bedrooms.

bedrooms_tointeger

Maximum number of bedrooms.

bathrooms_frominteger

Minimum number of bathrooms.

bathrooms_tointeger

Maximum number of bathrooms.

total_area_frominteger

Minimum total area.

total_area_tointeger

Maximum total area.

plot_area_frominteger

Minimum plot area.

plot_area_tointeger

Maximum plot area.

construction_year_frominteger

Minimum construction year.

construction_year_tointeger

Maximum construction year.

floor'no_floor' | 'ground' | 'middle' | 'top'

Floor type. <br/><strong>This field is deprecated and will be removed in the next major update.</strong><br/><strong>Please, use floors field instead.</strong>

floorsstring[]

List of floor types.

orientation'exterior' | 'interior'

Property view orientation.

view'water' | 'landscape' | 'city' | 'golf' | 'park'

View from the property. "<br/><strong>This field is deprecated and will be removed in the next major update.</strong><br/><strong>Please, use views field instead.</strong>"

viewsstring[]

List of views from the property.

direction'north' | 'south' | 'east' | 'west'

Cardinal direction the property faces. "<br/><strong>This field is deprecated and will be removed in the next major update.</strong><br/><strong>Please, use directions field instead.</strong>

directionsstring[]

List of cardinal directions the property faces.

characteristicsstring[]

Property characteristics.

alert_subtypesstring[]

Alert subtypes.

privateboolean

Whether to return alerts only from properties listed by a private individual, as opposed to an agent or a professional.

auctionboolean

Whether to return alerts from auction property listings.

bankboolean

Whether to return alerts from bank property listings.

new_developmentboolean

Whether to return alerts from new development property listings.

listing_agentsstring[]

Return alerts only for properties from specified agents. To find allowed agent names use the GET /api/v1/references/agents endpoint.

with_agenciesstring[]

Return alerts only for properties from specified agencies, companies or sources. To find allowed agency names use the GET /api/v1/references/agencies endpoint.

without_agenciesstring[]

Exclude alerts for properties from specified agencies, companies or sources. To find allowed agency names use the GET /api/v1/references/agencies endpoint.

exclusiveboolean

Whether to return alerts exclusively from specific listings rather than from all related to the property listings.<br/>Can be passed only along with at least one of the fields: private, with_agencies, without_agencies.

ref_numbersstring[]

List of reference numbers from listings.

has_phoneboolean

Whether to return alerts only from listings with or without phone number.

has_emailboolean

Whether to return alerts only from listings with or without email.

has_agency_nameboolean

Whether to return alerts only from listings with or without agency name.

property_idsinteger[]

List of property IDs.

listing_idsinteger[]

List of listing IDs.

Response

countinteger
nextstring uri nullable
previousstring uri nullable

Example response

[
  {
    "count": 123,
    "next": "http://api.example.org/accounts/?offset=400&limit=100",
    "previous": "http://api.example.org/accounts/?offset=200&limit=100"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.