|
| 1 | +# FTSE_SFTP |
| 2 | + |
| 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 | +| ✅ | SFTP_HOST | SFTP server hostname or IP address | string | | | |
| 12 | +| | SFTP_PORT | SFTP server port | number | | `22` | |
| 13 | +| ✅ | SFTP_USERNAME | SFTP username for authentication | string | | | |
| 14 | +| ✅ | SFTP_PASSWORD | SFTP password for authentication | string | | | |
| 15 | +| | SFTP_READY_TIMEOUT_MS | How long (in milliseconds) to wait for the SSH handshake to complete | number | | `30000` | |
| 16 | +| | BACKGROUND_EXECUTE_MS | The amount of time the background execute should sleep before performing the next request | number | | `10000` | |
| 17 | + |
| 18 | +--- |
| 19 | + |
| 20 | +## Data Provider Rate Limits |
| 21 | + |
| 22 | +There are no rate limits for this adapter. |
| 23 | + |
| 24 | +--- |
| 25 | + |
| 26 | +## Input Parameters |
| 27 | + |
| 28 | +| Required? | Name | Description | Type | Options | Default | |
| 29 | +| :-------: | :------: | :-----------------: | :----: | :--------------------: | :-----: | |
| 30 | +| | endpoint | The endpoint to use | string | [sftp](#sftp-endpoint) | `sftp` | |
| 31 | + |
| 32 | +## Sftp Endpoint |
| 33 | + |
| 34 | +`sftp` is the only supported name for this endpoint. |
| 35 | + |
| 36 | +### Input Params |
| 37 | + |
| 38 | +| Required? | Name | Aliases | Description | Type | Options | Default | Depends On | Not Valid With | |
| 39 | +| :-------: | :--------: | :-----: | :----------------------------------------------------: | :----: | :------------------------------------------------------------------------: | :-----: | :--------: | :------------: | |
| 40 | +| ✅ | instrument | | Abstract identifier of the index to fetch the data for | string | `FTSE100INDEX`, `Russell1000INDEX`, `Russell2000INDEX`, `Russell3000INDEX` | | | | |
| 41 | + |
| 42 | +### Example |
| 43 | + |
| 44 | +Request: |
| 45 | + |
| 46 | +```json |
| 47 | +{ |
| 48 | + "data": { |
| 49 | + "endpoint": "sftp", |
| 50 | + "instrument": "FTSE100INDEX" |
| 51 | + } |
| 52 | +} |
| 53 | +``` |
| 54 | + |
| 55 | +<details> |
| 56 | +<summary>Additional Examples</summary> |
| 57 | + |
| 58 | +Request: |
| 59 | + |
| 60 | +```json |
| 61 | +{ |
| 62 | + "data": { |
| 63 | + "endpoint": "sftp", |
| 64 | + "instrument": "Russell1000INDEX" |
| 65 | + } |
| 66 | +} |
| 67 | +``` |
| 68 | + |
| 69 | +Request: |
| 70 | + |
| 71 | +```json |
| 72 | +{ |
| 73 | + "data": { |
| 74 | + "endpoint": "sftp", |
| 75 | + "instrument": "Russell2000INDEX" |
| 76 | + } |
| 77 | +} |
| 78 | +``` |
| 79 | + |
| 80 | +Request: |
| 81 | + |
| 82 | +```json |
| 83 | +{ |
| 84 | + "data": { |
| 85 | + "endpoint": "sftp", |
| 86 | + "instrument": "Russell3000INDEX" |
| 87 | + } |
| 88 | +} |
| 89 | +``` |
| 90 | + |
| 91 | +</details> |
| 92 | + |
| 93 | +--- |
| 94 | + |
| 95 | +MIT License |
0 commit comments