Search API Best Practices

  • Cache your access token for 15 hrs and re-use until expiration
  • Use typeahead with user-initiated search, avoid unified search if possible.
    • Implement debouncing (e.g. 300 ms pause before invoking request) with typeahead
  • If using unified search, specify search categories as needed
  • Specify response fields in the request using the top-level object: provider_fields, availability_fields, location_fields
  • Specify 10 or fewer providers per page for optimal performance (up to 100 possible), use shuffle seed   
  • Use filters in the request to specify the criteria
  • Specify field level facets in addition to object level metadata, if needed
  • Specify a supported sort order to control the order of search results 
  • Expect rate limiting to take effect only when the number of requests for an access token reaches levels that indicate a possible threat: 12,000 requests per hour or 100 requests per second. Kyruus support can help adjust this if needed.
  • Use test credentials for testing not to affect your production environment analytics.