PHP IDX Library

PHP IDX Library

Using our PHP IDX Library you can develop custom IDX solutions using Agent Storm's. To use the Agent Storm with PHP you will need download agentstorm-lib-php from GitHub. Once downloaded you will only need to include the file agentstorm-lib.php in your site to begin using the library.

After you have signed up for an account and obtained you API keys you are ready to begin developing your solution.

By using Agent Storm as opposed to building you own RETS imports your web site or application can benefit from the stability and infrastructure used at Agent Storm to power your Property Listings.

Example Usage

The Gist below contains example usage of the Agent Storm PHP IDX Library:

Don't forget to change HOSTNAME and APIKEY with your Agent Storm hostname and API key respectively.

Classes

Classes define various data sets that can be queried.

• AgentStormContactsEndpoint( $sub_domain, $apikey )
  Search and Retrieval of Contacts
• AgentStormCompaniesEndpoint( $sub_domain, $apikey )
  Search and Retrieval of Companies
• AgentStormPropertiesEndpoint( $sub_domain, $apikey )
  Search and Retrieval of Properties

Filters

There are a number of filters which can be applied to queries such as:

• AgentStormFilter_Limit( $limit )
  Limit the number of results returned per call
• AgentStormFilter_Offset( $offset )
  Set the query offset or "Page"
• AgentStormFilter_Sort( $field, $directon )
  Sets the sort type for the results of the query
• AgentStormFilter_Range( $field, $min, $max )
  Has a value between two values
• AgentStormFilter_LessThan( $field, $value )
  Where field has a value less than
• AgentStormFilter_GreaterThan( $field, $value )
  Where field has a value greater than
• AgentStormFilter_Equals( $field, $value )
  Where field has a value equal to the passed value
• AgentStormFilter_In( $field, $array )
  Where field has a value equal to that in an array

Contribute

Found a bug? Want to contribute a feature? Fork the project on GitHub and let us know via our Support Site