Skip to content

Commit 38c3a24

Browse files
committed
Update Readme
1 parent 48e691f commit 38c3a24

File tree

1 file changed

+12
-5
lines changed

1 file changed

+12
-5
lines changed

README.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# AlphaSwiftage
22

3-
Lightweight Swift library to access the [Alpha Vantage API](https://www.alphavantage.co/documentation/).
3+
Lightweight Swift library to access the [Alpha Vantage API](https://www.alphavantage.co/documentation/). The library does also support the [Alpha Vantage API exposed on RapidAPI](https://rapidapi.com/alphavantage/api/alpha-vantage).
44

55
## Installation
66

@@ -14,20 +14,27 @@ dependencies: [
1414

1515
## Usage
1616

17+
Using the native Alpha Vantage API:
18+
1719
```swift
1820
import AlphaSwiftage
1921

2022
let service = AlphaVantageService(apiKey: "{YOUR_API_KEY}")
2123
let symbols = try await service.symbolSearch(keywords: "VWCE")
2224
```
2325

26+
Alpha Vantage API exposed on RapidAPI:
27+
28+
```swift
29+
import AlphaSwiftage
30+
31+
let service = AlphaVantageService(serviceType: .rapidAPI(apiKey: "{YOUR_API_KEY}"))
32+
let symbols = try await service.symbolSearch(keywords: "VWCE")
33+
```
34+
2435
## Supported routes
2536

2637
- [Symbol Search](https://www.alphavantage.co/documentation/#symbolsearch)
2738
- [Quote](https://www.alphavantage.co/documentation/#latestprice)
2839
- [Exchange Rates](https://www.alphavantage.co/documentation/#currency-exchange)
2940
- [Time Series - Daily Adjusted](https://www.alphavantage.co/documentation/#dailyadj)
30-
31-
## API Key
32-
33-
You can get a free API Key [here](https://www.alphavantage.co/support/#api-key).

0 commit comments

Comments
 (0)