|
1 | | -# Chainlink External Adapter for deutsche-boerse |
| 1 | +# DEUTSCHE_BOERSE |
2 | 2 |
|
3 | | -This README will be generated automatically when code is merged to `main`. If you would like to generate a preview of the README, please run `yarn generate:readme deutsche-boerse`. |
| 3 | +  |
| 4 | + |
| 5 | +This document was generated automatically. Please see [README Generator](../../scripts#readme-generator) for more info. |
| 6 | + |
| 7 | +## Environment Variables |
| 8 | + |
| 9 | +| Required? | Name | Description | Type | Options | Default | |
| 10 | +| :-------: | :-------------: | :---------------------------: | :----: | :-----: | :----------------------------: | |
| 11 | +| ✅ | API_KEY | An API key for Data Provider | string | | | |
| 12 | +| | WS_API_ENDPOINT | WS endpoint for Data Provider | string | | `wss://md.deutsche-boerse.com` | |
| 13 | + |
| 14 | +--- |
| 15 | + |
| 16 | +## Data Provider Rate Limits |
| 17 | + |
| 18 | +There are no rate limits for this adapter. |
| 19 | + |
| 20 | +--- |
| 21 | + |
| 22 | +## Input Parameters |
| 23 | + |
| 24 | +| Required? | Name | Description | Type | Options | Default | |
| 25 | +| :-------: | :------: | :-----------------: | :----: | :--------------------: | :-----: | |
| 26 | +| | endpoint | The endpoint to use | string | [lwba](#lwba-endpoint) | `lwba` | |
| 27 | + |
| 28 | +## Lwba Endpoint |
| 29 | + |
| 30 | +`lwba` is the only supported name for this endpoint. |
| 31 | + |
| 32 | +### Input Params |
| 33 | + |
| 34 | +| Required? | Name | Aliases | Description | Type | Options | Default | Depends On | Not Valid With | |
| 35 | +| :-------: | :----: | :------------------: | :--------------------------------------------: | :----: | :--------------: | :-----: | :--------: | :------------: | |
| 36 | +| ✅ | isin | `ISIN`, `instrument` | The ISIN identifier of the instrument to query | string | | | | | |
| 37 | +| ✅ | market | `stream` | The market identifier of the stream to query | string | `md-xetraetfetp` | | | | |
| 38 | + |
| 39 | +### Example |
| 40 | + |
| 41 | +Request: |
| 42 | + |
| 43 | +```json |
| 44 | +{ |
| 45 | + "data": { |
| 46 | + "endpoint": "lwba", |
| 47 | + "market": "md-xetraetfetp", |
| 48 | + "isin": "IE00B53L3W79" |
| 49 | + } |
| 50 | +} |
| 51 | +``` |
| 52 | + |
| 53 | +--- |
| 54 | + |
| 55 | +MIT License |
0 commit comments