Overnight Averages
** View Overnight Average Rates **
Valid endpoints have the pattern `/api/overnight_averages/Type` valid types are:
`deposit_historical`
`mortgage_historical`
`auto`
`deposit`
`mortgage`
* * *
** General Parameters: **
- `zipcode` - This will override the zip code that is automatically derived from the client's location
- `postal_code` - [Same as zipcode, but this will take precedence] This will override the zip code that is automatically derived from the client's location
- `max_listings` - The maximum number of listings to return
- `preferred_institution` - This determines which institution will be floated to the top of the results. Can be repeated. Value is the institution name
** Add each as an additional parameter, for example: preferred_institution=a&preferred_institution=b **
- `skip_api_preferred_institutions` - Skip applying API level Preferred Institutions (Default = `false`)
- `deferred_institution` - This determines which institution will appear last in the results. Can be repeated. Value is the institution name
** Add each as an additional parameter, for example: deferred_institution=a&deferred_institution=b **
- `skip_api_deferred_institutions` - Skip applying API level Deferred Institutions (Default = `false`)
- `ignored_institution` - This determines which institution will be removed from the results. Can be repeated. Value is the institution name
** Add each as an additional parameter, for example: ignored_institution=a&ignored_institution=b **
- `skip_api_ignored_institutions` - Skip applying API level Ignored Institutions (Default = `false`)
- `force_allow_institution` - This will cancel any ignored_institution rule or query parameter. Can be repeated. Value is the institution name
** Add each as an additional parameter, for example: force_allow_institution=a&force_allow_institution=b **
- `preferred_product` - A few words of descriptions...
** Add each as an additional parameter, for example: preferred_product=a&preferred_product=b **
- `preferred_products_only` - A few words of descriptions... (Default = `false`)
- `force_preferred` - Shows only preferred institutions in the results. Value is `true` or `false` (Default = `false`)
- `sort_preferred` - Sort preferred institution in the order they are set on the feed, set to `false` to use their natural api ordering (Default = `true`)
- `allow_preferred_editorial` - Allows the preferred institution to be an editorial listing (Default = `false`)
- `force_url_override` - A few words of descriptions... (Default = `false`)
- `product_feed_id` - A few words of descriptions...
- `no_cache` - A few words of descriptions... (Default = `false`)
- `utm_medium` - A few words of descriptions...
- `initial_request` - A few words of descriptions... (Default = `false`)
- `is_generic` - A few words of descriptions... (Default = `false`)
- `fire_pixel` - If the traffic source has a configured pixel, should it fire on listing clicks? (Default = `false`)
- `debug_feed` - Used to debug the feed, on supported Backends this will attached the external api response (Default = `false`)
** OvernightAveragesMortgageHistoricalApi Parameters: **
- `timespan` - Number of days to retrieve historical averages for. (Default = `1`)
GET /api/overnight_averages/mortgage_historical?format=api
{
"30-yr-fixed": [],
"15-yr-fixed": [],
"30-yr-fixed-refi": [],
"15-yr-fixed-refi": []
}