Skip to content

Commit

Permalink
update readme(add links to ipf samples, add part samples )
Browse files Browse the repository at this point in the history
  • Loading branch information
kosyloa committed Nov 2, 2023
1 parent 1782e36 commit 9ed27bf
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 4 deletions.
18 changes: 14 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ and [dxFeed Java API](https://docs.dxfeed.com/dxfeed/api/overview-summary.html)
- [Requirements](#requirements)
- [Usage](#usage)
- [Tools](#tools)
- [Samples](#samples)
- [Current State](#current-state)

## Overview
Expand Down Expand Up @@ -186,6 +187,15 @@ To run tools on macOs, it may be necessary to unquarantine them:
sudo /usr/bin/xattr -r -d com.apple.quarantine <directory_with_tools>
```

## Samples

* [IpfConnect](https://github.com/dxFeed/dxfeed-graal-swift-api/blob/swift/Samples/Tools/IpfConnect.swift)
This sample demonstrates how to subscribe to available symbols using IPF. It uses a DxFeed and dxfeed.properties file
* [LiveIpfSample](https://github.com/dxFeed/dxfeed-graal-swift-api/blob/swift/Samples/Tools/LiveIpfSample.swift)
This sample demonstrates how to an instrument profile URL and reads instrument profiles with support of streaming live updates.
* [ScheduleSample](https://github.com/dxFeed/dxfeed-graal-swift-api/blob/swift/Samples/Tools/ScheduleSample.swift)
This sample demonstrates different use cases of Schedule API.

## Current State

### Endpoint Roles
Expand Down Expand Up @@ -346,16 +356,16 @@ sudo /usr/bin/xattr -r -d com.apple.quarantine <directory_with_tools>

- [x] [InstrumentProfile](https://docs.dxfeed.com/dxfeed/api/com/dxfeed/ipf/InstrumentProfile.html)
represents basic profile information about a market instrument
([Java API sample](https://github.com/devexperts/QD/blob/master/dxfeed-samples/src/main/java/com/dxfeed/sample/ipf/DXFeedIpfConnect.java))
([Java API sample](https://github.com/devexperts/QD/blob/master/dxfeed-samples/src/main/java/com/dxfeed/sample/ipf/DXFeedIpfConnect.java), [Swift API sample](https://github.com/dxFeed/dxfeed-graal-swift-api/blob/swift/Samples/Tools/IpfConnect.swift))

- [x] [InstrumentProfileCollector](https://docs.dxfeed.com/dxfeed/api/com/dxfeed/ipf/live/InstrumentProfileCollector.html)
collects instrument profile updates and provides the live instrument profiles list
([Java API sample](https://github.com/devexperts/QD/blob/master/dxfeed-samples/src/main/java/com/dxfeed/sample/ipf/DXFeedLiveIpfSample.java))

([Java API sample](https://github.com/devexperts/QD/blob/master/dxfeed-samples/src/main/java/com/dxfeed/sample/ipf/DXFeedLiveIpfSample.java), [Swift API sample](https://github.com/dxFeed/dxfeed-graal-swift-api/blob/swift/Samples/Tools/LiveIpfSample.swift))
- [x] [Schedule](https://docs.dxfeed.com/dxfeed/api/com/dxfeed/schedule/Schedule.html)
provides an API to retrieving and exploring the trading schedules of various exchanges and different financial
instrument classes
([Java API sample](https://github.com/devexperts/QD/blob/master/dxfeed-samples/src/main/java/com/dxfeed/sample/schedule/ScheduleSample.java))
([Java API sample](https://github.com/devexperts/QD/blob/master/dxfeed-samples/src/main/java/com/dxfeed/sample/schedule/ScheduleSample.java), [Swift API sample](https://github.com/dxFeed/dxfeed-graal-swift-api/blob/swift/Samples/Tools/ScheduleSample.swift))

### Services

Expand Down
1 change: 1 addition & 0 deletions Samples/Tools/IpfConnect.swift
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ class IpfConnect: ToolsCommand {
let profiles = try? DXInstrumentProfileReader().readFromFile(address: fileName)
print("Selected symbols are:")
let result = profiles?.compactMap({ profile in
// This is just a sample, any arbitrary filtering may go here.
if profile.type == "STOCK" {
print("\(profile.symbol) (\(profile.descriptionStr))")
return profile.symbol
Expand Down

0 comments on commit 9ed27bf

Please sign in to comment.