Skip to content

Commit 56ba70f

Browse files
authored
Update README.md
1 parent d6b5337 commit 56ba70f

File tree

1 file changed

+22
-12
lines changed

1 file changed

+22
-12
lines changed

README.md

Lines changed: 22 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,23 @@
1-
# Forex Latest Prices API - PHP
1+
# Live Forex API - PHP
22

3-
V3 Update: 2021-02-12
3+
<b>Update: 2021-02-12 (version 3)</b>
44

5-
FCS forex exchange quotes API is a PHP Library for fetching forex quotes, provide response in JSON format
5+
FCS currency exchange quotes API is a PHP Library for fetching forex quotes, provide response in array or JSON format.
6+
This library is designed to get latest exchange quotes data, historical rates, economy calendar and indicators data.
7+
8+
## API Supports
9+
* 2000+ Currency exchange rates.
10+
* 10 secods price update frequency
11+
* 25 years historical data
12+
* MA lines and indicators signals
13+
* Economic calendar data
614

715
## Requirements
816
* PHP >= 5.6
917
* An API key, you can get free at https://fcsapi.com/dashboard
1018

1119
## Installation
12-
Download zip OR api directory from github and place it in your project, and in your php file.
20+
Include FCS php library files in your project from github. Next
1321
````PHP
1422
<?php
1523
use FCS\FCS_forex;
@@ -22,18 +30,20 @@ require_once(__DIR__.'/api/FCS_forex.php'); // Include library
2230
<?php
2331

2432
// You can get your API key from fcsapi.com
25-
define('FCS_KEY','API_KEY');
33+
define('FCS_KEY', 'API_KEY');
2634

27-
$forex = new FCS_forex(); // class object
35+
$forex = new FCS_forex(); // create class object
2836

2937
````
30-
### API Output
31-
Default output is array in php, valid values are: array, json, jsonp, object, xml, serialize
38+
### API reponse format
39+
Default output is array for php, valid values are: array, json, jsonp, object, xml, serialize
3240
```PHP
33-
$forex->set_output_type('JSON');
41+
$forex->set_output_type('JSON'); // optional
3442
```
3543
### Get the list of available symbols:
36-
> $response = $forex->get_symbols_list();
44+
````PHP
45+
$response = $forex->get_symbols_list();
46+
````
3747

3848
### Get quotes for specific currency:
3949
````PHP
@@ -91,8 +101,8 @@ You can check full documentaions here [https://fcsapi.com/document/forex-api](h
91101
$response = $forex-> get_search_query('BTC Dollar',0); // contain any words
92102
$response = $forex-> get_search_query('BTC Dollar',1); // contain all words
93103

94-
$params = array('id'=>1,'period'=>'1h','limit'=>2);
95-
$response = $forex-> get_history($params);
104+
$response = $forex-> get_history( ['id'=>1,'period'=>'1h'] );
105+
$response = $forex-> get_history( ['id'=>1,'period'=>'1h','from'=>'2020-01-01', 'to'=>'2020-01-31'] );
96106

97107
````
98108

0 commit comments

Comments
 (0)