You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+33-9Lines changed: 33 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -43,17 +43,41 @@ The FinFeedAPI family includes the following specific APIs and SDKs present in t
43
43
44
44
## Repository organization
45
45
46
+
The repository is organized into two main product families, `coinapi` and `finfeedapi`. Each of these contains subdirectories for specific APIs and their associated SDKs or samples.
47
+
48
+
### CoinAPI Directories
49
+
50
+
Directory | Description |
51
+
--- | --- |
52
+
`coinapi/market-data-api-rest` | SDK for CoinAPI Market Data REST API |
53
+
`coinapi/market-data-api-ws` | SDK for CoinAPI Market Data WebSocket API |
54
+
`coinapi/market-data-api-fix` | SDK for CoinAPI Market Data FIX API |
55
+
`coinapi/ems-cloud-mgmt-api` | SDK for CoinAPI Execution Management System Managed Cloud REST API |
56
+
`coinapi/ems-api-rest` | SDK for CoinAPI Execution Management System REST API |
57
+
`coinapi/ems-api-fix` | SDK for CoinAPI Execution Management System FIX API |
58
+
`coinapi/indexes-api-rest` | SDK for CoinAPI Indexes REST API |
59
+
`coinapi/exchange-rates-api-historical` | SDK for CoinAPI Exchange Rates Historical REST API |
60
+
`coinapi/exchange-rates-api-realtime` | SDK for CoinAPI Exchange Rates Realtime REST API (this might also cover WebSocket or be split, TBC) |
61
+
`coinapi/exchange-rates-api-rest-historical` | SDK for CoinAPI Exchange Rates REST Historical API (potentially redundant or more specific version of `exchange-rates-api-historical`) |
62
+
`coinapi/exchange-rates-api-rest-realtime` | SDK for CoinAPI Exchange Rates REST Realtime API (potentially redundant or more specific version of `exchange-rates-api-realtime`) |
63
+
`coinapi/flat-files-api-processing-samples` | Examples related to processing GZIP+CSV flat files |
64
+
65
+
### FinFeedAPI Directories
66
+
46
67
Directory | Description |
47
68
--- | --- |
48
-
`coinapi/market-data-api` | SDK for CoinAPI Market Data API |
49
-
`coinapi/ems-cloud-mgmt-sdk` | SDK for CoinAPI Execution Management System Managed Cloud REST API |
50
-
`coinapi/ems-gateway-rest-sdk` | SDK for CoinAPI Execution Management System REST API |
51
-
`coinapi/ems-gateway-fix` | SDK for CoinAPI Execution Management System FIX API |
52
-
`coinapi/flat-files-api-processing-samples` | Examples related to processing CryptoTick GZIP+CSV flat files |
53
-
`coinapi/indexes-api` | SDK for CoinAPI Indexes API |
54
-
`coinapi/exchange-rates-api` | SDK for CoinAPI Exchange Rates API |
55
-
`finfeedapi/stock-api` | SDK for FinFeed API Stock API |
56
-
`finfeedapi/sec-api` | SDK for FinFeed API SEC API |
69
+
`finfeedapi/stock-api-rest` | SDK for FinFeed API Stock REST API |
70
+
`finfeedapi/sec-api-rest` | SDK for FinFeed API SEC REST API |
71
+
72
+
## OpenAPI Specifications
73
+
74
+
OpenAPI (formerly Swagger) specification files, typically named `openapi.yaml` or `openapi.json`, are provided for many of the RESTful APIs in this repository. These files define the API's structure and can be used with various tools for documentation generation, client SDK creation, and testing.
75
+
76
+
You can generally find these specification files within the respective API's directory. Common locations include:
77
+
* A `spec/` subdirectory directly within the API's folder (e.g., `coinapi/market-data-api-rest/spec/openapi.yaml`).
78
+
* Within language-specific SDK directories, often under an `api/` or similar subdirectory (e.g., `finfeedapi/sec-api-rest/sdk/java/api/openapi.yaml`).
79
+
80
+
Please explore the individual API directories for the most up-to-date and specific locations of these files.
0 commit comments