docs/ForexApi.md in intrinio-sdk-5.6.1 vs docs/ForexApi.md in intrinio-sdk-5.6.3
- old
+ new
@@ -53,20 +53,16 @@
require 'pp'
# Setup authorization
Intrinio.configure do |config|
config.api_key['api_key'] = 'YOUR_API_KEY'
+ config.allow_retries = true
end
forex_api = Intrinio::ForexApi.new
-
-begin
- result = forex_api.get_forex_currencies
- pp result
-rescue Intrinio::ApiError => e
- puts "Exception when calling ForexApi->get_forex_currencies: #{e}"
-end
+result = forex_api.get_forex_currencies
+pp result
```
[//]: # (END_CODE_EXAMPLE)
[//]: # (START_DEFINITION)
@@ -129,20 +125,16 @@
require 'pp'
# Setup authorization
Intrinio.configure do |config|
config.api_key['api_key'] = 'YOUR_API_KEY'
+ config.allow_retries = true
end
forex_api = Intrinio::ForexApi.new
-
-begin
- result = forex_api.get_forex_pairs
- pp result
-rescue Intrinio::ApiError => e
- puts "Exception when calling ForexApi->get_forex_pairs: #{e}"
-end
+result = forex_api.get_forex_pairs
+pp result
```
[//]: # (END_CODE_EXAMPLE)
[//]: # (START_DEFINITION)
@@ -205,34 +197,29 @@
require 'pp'
# Setup authorization
Intrinio.configure do |config|
config.api_key['api_key'] = 'YOUR_API_KEY'
+ config.allow_retries = true
end
forex_api = Intrinio::ForexApi.new
+pair = "EURUSD"
+timeframe = "D1"
-pair = "EURUSD" # String | The Forex Currency Pair code
-
-timeframe = "D1" # String | The time interval for the quotes
-
-opts = {
- timezone: "UTC", # String | Returns trading times in this timezone
- start_date: nil, # Date | Return Forex Prices on or after this date
- start_time: nil, # String | Return Forex Prices at or after this time (24-hour)
- end_date: nil, # Date | Return Forex Prices on or before this date
- end_time: nil, # String | Return Forex Prices at or before this time (24-hour)
- page_size: 100, # Integer | The number of results to return
- next_page: nil # String | Gets the next page of data from a previous API call
+opts = {
+ timezone: "UTC",
+ start_date: Date.parse("2018-01-01"),
+ start_time: nil,
+ end_date: Date.parse("2019-01-01"),
+ end_time: nil,
+ page_size: 100,
+ next_page: nil
}
-begin
- result = forex_api.get_forex_prices(pair, timeframe, opts)
- pp result
-rescue Intrinio::ApiError => e
- puts "Exception when calling ForexApi->get_forex_prices: #{e}"
-end
+result = forex_api.get_forex_prices(pair, timeframe, opts)
+pp result
```
[//]: # (END_CODE_EXAMPLE)
[//]: # (START_DEFINITION)
@@ -246,12 +233,12 @@
------------- | ------------- | ------------- | -------------
**pair** | String| The Forex Currency Pair code |
**timeframe** | String| The time interval for the quotes |
**timezone** | String| Returns trading times in this timezone | [optional] [default to UTC]
**start_date** | Date| Return Forex Prices on or after this date | [optional]
- **start_time** | String| Return Forex Prices at or after this time (24-hour) | [optional]
+ **start_time** | String| Return Forex Prices at or after this time (24-hour in 'hh:mm' format, UTC timezone) | [optional]
**end_date** | Date| Return Forex Prices on or before this date | [optional]
- **end_time** | String| Return Forex Prices at or before this time (24-hour) | [optional]
+ **end_time** | String| Return Forex Prices at or before this time (24-hour in 'hh:mm' format, UTC timezone) | [optional]
**page_size** | Integer| The number of results to return | [optional] [default to 100]
**next_page** | String| Gets the next page of data from a previous API call | [optional]
[//]: # (END_PARAMETERS)