| Since: |
Friday, December 07, 2007 |
| Pricing: |
Requests against this operation count as one hit. |
| Inputs: |
| Name |
Description |
Required |
Example |
| RateType |
The type of rate. Use GetRateDescription to learn more about supported rates.
|
Yes |
Prime |
| PeriodType |
The type of period (Daily, Weekly, Monthly, Annually). |
Yes |
Monthly |
| FromDate |
The start date for the collection of rates. Availables rates dated after this date will be returned. |
Yes |
3/20/2009 |
| ToDate |
The end date for the collection of rates. Availables rates dates before this date will be returned. |
Yes |
3/20/2010 |
|
| Outputs: |
| Name |
Description |
Always Present |
| Type |
The type of interest rate. |
Yes |
| Instance of Description |
Each instance represents a rate description. |
Yes |
| Type |
The type of rate. |
Yes |
| Description |
A description of the rate. |
Yes |
| Name |
The name for the rate. Helpful to dynamically display names in an applicaion. |
Yes |
| Maturity |
The description of the maturity for the rate. |
Yes |
| MaturityUnit |
The maturity unit for the rate. |
Yes |
| MaturityCount |
The maturity count source for the rate. |
Yes |
| SeasonallyAdjusted |
If the rate is seasonally adjusted. |
Yes |
| Availability |
The availability of the description for the rate. |
Yes |
| Source |
The source for the description. |
Yes |
| Service |
Indicates the Xignite web service for which a subscription is required to be able to pull this rate. |
Yes |
| Suffix |
The suffix for the rate. Generally % is the suffix for most rates but some are expressed as basis points (bp). |
Yes |
| Factor |
A factor to apply to the Value field returned for the rate in order to return a percentage. 'Value' is expressed as a percentage for some interest rate and as the actual rate value for others. Use this Factor field to convert the Value field according to your needs. For instance Value * Factor will always return a percentage. |
Yes |
| Precision |
The number of decimals provided for this rate. |
Yes |
| Array of Rates |
Returns an array of rates. |
Yes |
| Instance of Rate |
Each instance represents a rate. |
Yes |
| Date |
The date for the rate. |
Yes |
| Value |
The value for the interest rate as of the date. This value is expressed as a percentage for some interest rate and as the actual rate value for others. Use the Factor field from the rate Description to convert this value according to your needs. For instance Value * Factor will always return a percentage. |
Yes |
| Text |
The value for the date as a text (string). |
Yes |
|