Class InstantValuation

Staticcreate

• create(
      valuationParams: InstantValuationParams,
  ): Promise<
      | {
          errors: { message: string }[];
          errorType: InstantValuationErrorType;
          valuation: null;
      }
      | {
          errors: null;
          errorType?: undefined;
          valuation: | {
              lower_bound?: number;
              price?: number;
              upper_bound?: number;
              valuation_errors?: string[];
          }
          | null;
      },
  >

  Requests an instant valuation estimate and, when trigger_iov_on_create is set, creates a matching lead in a single call to the Valuations API.

  Parameters

  • valuationParams: InstantValuationParams

  Returns Promise<
      | {
          errors: { message: string }[];
          errorType: InstantValuationErrorType;
          valuation: null;
      }
      | {
          errors: null;
          errorType?: undefined;
          valuation: | {
              lower_bound?: number;
              price?: number;
              upper_bound?: number;
              valuation_errors?: string[];
          }
          | null;
      },
  >

  Example

  const { valuation, errors } = await InstantValuation.create({
    valuation: { postcode: 'BN2 9SQ', paon: '10', property_type: 'terrace', bedrooms: 3 },
    lead_params: {
      user: { first_name: 'Jane', last_name: 'Smith', email: 'jane@example.com' },
      valuation_department: 'Sales valuation',
    },
    trigger_iov_on_create: true,
  });
  Copy