Back

Lofty API Essential Guide

Aug 13, 20246 minute read

What type of API does Lofty provide?

Based on the search results provided, there is no specific information about what type of API Lofty uses. The search results contain general information about different API types like REST, GraphQL, SOAP, and gRPC, but do not mention Lofty specifically.

To accurately determine what type of API Lofty uses, we would need to:

  1. Check Lofty's official documentation or developer resources if available.
  2. Look for any API endpoints or integration guides provided by Lofty.
  3. Contact Lofty's support or developer relations team directly.

Without more specific information about Lofty, I cannot definitively state what type of API they use. The most common API types for modern web services are REST and GraphQL, but companies may use other types or custom implementations as well.

If you need to integrate with Lofty's API, I would recommend:

  1. Checking their official documentation first
  2. Looking for any developer guides or API references they provide
  3. Reaching out to their support team if the information is not publicly available

This would give you the most accurate and up-to-date information about Lofty's specific API implementation.

Does the Lofty API have webhooks?

Availability of Webhooks

The official Lofty API does not appear to have native webhook support. The search results do not provide any direct information about official Lofty API webhooks or events you can subscribe to.

Third-Party Integration Options

While native webhooks are not mentioned, there are some third-party integration options that allow connecting Lofty to webhook services:

  1. Zapier Integration:

    • Zapier offers an integration between Lofty and Webhooks by Zapier.
    • This integration allows triggering a webhook when a new lead is created in Lofty.
  2. Integrately Integration:

    • Integrately provides an integration between Lofty and Webhook/API Integration.
    • It offers triggers like "Lead is created or updated in Lofty" and "Lead pipeline is changed in Lofty".

Key Considerations

  • The lack of information about official Lofty API webhooks suggests that native webhook support may not be available.
  • Third-party integration platforms like Zapier and Integrately can be used to create webhook-like functionality for Lofty.
  • These integrations typically focus on lead-related events in Lofty, such as new lead creation or updates.

Conclusion

Based on the available information, it appears that the official Lofty API does not have native webhook support. However, users can leverage third-party integration platforms to create webhook-like functionality for specific events in Lofty, primarily related to lead management.

For the most up-to-date and accurate information, it would be best to consult the official Lofty API documentation or contact their support team directly.

Rate Limits and other limitations

Based on the search results provided, here are the API Rate Limits for the Lofty API:

Rate Limit Details

The Lofty API implements rate limiting to control the number of requests that can be made within a specific time frame. The rate limit details are as follows:

  1. Default rate limit: 500 requests per minute [1]

  2. Rate limit without a valid vendorKey: 10 calls per minute (effective from June 15, 2021) [1]

Rate Limit Headers

The API returns the following HTTP headers with each response to provide information about the current rate limit status [1]:

  1. X-RateLimit-Limit: The maximum number of requests allowed in the limited time (default: 500/minute)

  2. X-RateLimit-Remaining: The number of requests remaining in the current rate limit window

  3. X-RateLimit-Reset: The time at which the current rate limit window resets in UTC epoch seconds (default: 60000 milliseconds)

Key Points to Consider

  • Rate limiting was implemented on June 15, 2021, for all users not using a vendorKey [1]

  • API access will be unavailable after July 15, 2021, if a vendorKey is not implemented [1]

  • Users are advised to complete the application for a security key before July 15, 2021, to ensure uninterrupted service for connected applications [1]

  • If the rate limit is exceeded without a valid vendorKey, an error will be returned, and the endpoints can be called again after one minute with the same limit of 10 calls per minute [1]

Best Practices

  1. Implement a vendorKey to avoid the stricter rate limits imposed on users without one

  2. Monitor the rate limit headers in API responses to track your usage and avoid exceeding the limits

  3. Design your application to handle rate limit errors gracefully and implement appropriate retry mechanisms

  4. Consider implementing caching strategies to reduce the number of API calls when possible

By adhering to these rate limits and implementing the recommended best practices, you can ensure smooth integration with the Lofty API while avoiding potential disruptions due to exceeding the allowed request limits.

Latest API Version

Based on the search results provided, the most recent version of the Lofty API is:

Version 1.0 [1]

Key points to consider:

  • This version information is listed under section 1.1 "Version information" in the API documentation [1].

  • The API is referred to as the "Lofty Open API" throughout the documentation [1].

  • The base URL for the API is api.lofty.com [1].

  • The API uses OAuth 2.0 for authentication [1].

  • There are rate limits in place for API requests, with headers indicating the current rate limit status [1].

Best practices:

  • When using the API, make sure to include the proper authentication headers with a valid OAuth 2.0 access token [1].

  • Pay attention to the rate limit headers in API responses to avoid exceeding usage limits [1].

  • Refer to the full API documentation for details on available endpoints and request/response formats [1].

How to get a Lofty developer account and API Keys?

To get a developer account for Lofty and create an API integration, you'll need to follow these steps:

1. Sign up for a Lofty account

First, you'll need to create a regular Lofty account if you don't already have one. This is typically done through their main website.

2. Request API access

Once you have a Lofty account:

  • Contact Lofty's support or sales team to request API access for developers.
  • Explain your intended use case for the API integration.
  • They may require additional information or verification before granting API access.

3. Obtain OAuth 2.0 credentials

After being approved for API access:

  • Lofty will provide you with OAuth 2.0 credentials, typically including a client ID and client secret.
  • These credentials are necessary for authenticating your API requests.

4. Review API documentation

Familiarize yourself with the Lofty Open API documentation:

  • The current API version is 1.0.
  • The base URL for API requests is https://api.lofty.com/.
  • Review the available endpoints and their functionalities.

5. Implement OAuth 2.0 authentication

In your application:

  • Implement the OAuth 2.0 flow to obtain an access token.
  • Use this access token in the Authorization header of your API requests.

6. Start making API requests

Once authenticated:

  • You can begin making API requests to Lofty's endpoints.
  • Ensure you're following their rate limiting guidelines and best practices.

What can you do with the Lofty API?

Based on the provided search results, here is a list of data models you can interact with using the Lofty API, along with what is possible for each:

Agent User

  • Create a new agent with profile message

Calls

  • Search for calls
  • Retrieve a call by Id

Communication

  • Search for communication by agent
  • Search for call history
  • Search for call history v2
  • Search for email history
  • Search for text history

LeadRouting

  • Get Assign Member List
  • Get Assign Role List
  • Get Routing List
  • Get default rule
  • Edit default routing rule
  • Edit routing rule

Leads

  • Edit a lead from brokermint
  • Update a transaction from brokermint
  • Create a new lead
  • Search for leads
  • Search for assignee by lead info
  • Search for leads by create time
  • Retrieve the specified URL with a login token
  • Search for leads by update time
  • Retrieve a lead by Id
  • Edit a lead
  • Delete a lead
  • Search for activities
  • Add activity
  • Assign a lead
  • Place an inquiry
  • Place a property
  • Add a transaction
  • Update address of transaction's property
  • Query transaction by leadId AND transactionId
  • Update a transaction
  • Query address of transaction's property by transactionId
  • Query transactions by leadId
  • Query transaction all custom fields

Members

  • Get current user's info
  • Get team members
  • Get member by account
  • Get user by Id
  • Edit a user

Notes

  • Add a note
  • Search for notes
  • Get note by Id
  • Edit a note
  • Delete a note

Tasks & Appointments

  • Get appointments of lead
  • Add a new task
  • Get tasks of lead
  • Get task by Id
  • Update a new task
  • Delete a task

TeamFeatures

  • Search lead pond
  • List lead pond
  • Add new custom field
  • Search custom field
  • Search existing tag

User Account

  • Create a new account
  • Edit an account

Vendor

  • Query vendor info
  • Get oauth token info by old apikey

Webhooks

  • Add a new webhook
  • Delete a webhook
  • Get all webhook from current team

Agent Organization

  • Get User Organization
  • Edit Agent Company
  • Update Agent Office
  • Add Agent Office
  • Get Permission Profiles

Broker

  • Create team under the broker account
  • Remove team from the broker account

Listing

  • Get published listings
  • Get by UserId

LogType

  • Add a log call/email/text
  • Search for log call/email/text
  • Get log call/email/text by Id
  • Delete a log type

Opportunity

  • Send Opportunity Notification

System Logs

  • Search for system logs