Skip to content

Commit 1678742

Browse files
Release 1.319.0 (#4853)
* Release 1.319.0 (deletions) * Release 1.319.0 (.) * Release 1.319.0 (packages/sources/itick) --------- Co-authored-by: app-token-issuer-data-feeds[bot] <134377064+app-token-issuer-data-feeds[bot]@users.noreply.github.com>
1 parent 7175ba6 commit 1678742

7 files changed

Lines changed: 52 additions & 250 deletions

File tree

.changeset/all-tigers-reply.md

Lines changed: 0 additions & 5 deletions
This file was deleted.

.changeset/nine-moons-attack.md

Lines changed: 0 additions & 5 deletions
This file was deleted.

MASTERLIST.md

Lines changed: 2 additions & 2 deletions
Large diffs are not rendered by default.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@chainlink/external-adapters-js",
3-
"version": "1.318.0",
3+
"version": "1.319.0",
44
"license": "MIT",
55
"private": true,
66
"workspaces": [
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# @chainlink/itick-adapter
2+
3+
## 1.0.0
4+
5+
### Major Changes
6+
7+
- [#4844](https://github.com/smartcontractkit/external-adapters-js/pull/4844) [`19e4a48`](https://github.com/smartcontractkit/external-adapters-js/commit/19e4a48ef8c59c25d405273a9ff87ed57c91e291) Thanks [@dskloetc](https://github.com/dskloetc)! - Add a region field to the params instead of having different endpoints for different regions.
8+
9+
- [#4765](https://github.com/smartcontractkit/external-adapters-js/pull/4765) [`be85ca9`](https://github.com/smartcontractkit/external-adapters-js/commit/be85ca9601522ed3fe725a87e54378a6e0aa8b4c) Thanks [@dskloetc](https://github.com/dskloetc)! - Initial implementation

packages/sources/itick/README.md

Lines changed: 39 additions & 236 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,16 @@
11
# ITICK
22

3-
![0.0.0](https://img.shields.io/github/package-json/v/smartcontractkit/external-adapters-js?filename=packages/sources/itick/package.json) ![v3](https://img.shields.io/badge/framework%20version-v3-blueviolet)
3+
![1.0.0](https://img.shields.io/github/package-json/v/smartcontractkit/external-adapters-js?filename=packages/sources/itick/package.json) ![v3](https://img.shields.io/badge/framework%20version-v3-blueviolet)
44

55
This document was generated automatically. Please see [README Generator](../../scripts#readme-generator) for more info.
66

77
## Environment Variables
88

9-
| Required? | Name | Description | Type | Options | Default |
10-
| :-------: | :-------------: | :-------------------------------: | :----: | :-----: | :---------------------: |
11-
| | API_KEY_HK | The API key for region 'HK' | string | | |
12-
| | API_KEY_CN | The API key for region 'CN' | string | | |
13-
| | API_KEY_GB | The API key for region 'GB' | string | | |
14-
| | API_KEY_KR | The API key for region 'KR' | string | | |
15-
| | API_KEY_JP | The API key for region 'JP' | string | | |
16-
| | API_KEY_TW | The API key for region 'TW' | string | | |
17-
| | API_ENDPOINT | An API endpoint for Data Provider | string | | `https://api.itick.org` |
18-
| | WS_API_ENDPOINT | WS endpoint for Data Provider | string | | `wss://api.itick.org` |
9+
| Required? | Name | Description | Type | Options | Default |
10+
| :-------: | :-------------: | :-----------------------------------: | :----: | :-----: | :---------------------: |
11+
|| API_KEY | The API key for the data provider API | string | | |
12+
| | API_ENDPOINT | An API endpoint for Data Provider | string | | `https://api.itick.org` |
13+
| | WS_API_ENDPOINT | WS endpoint for Data Provider | string | | `wss://api.itick.org` |
1914

2015
---
2116

@@ -29,19 +24,20 @@ This document was generated automatically. Please see [README Generator](../../s
2924

3025
## Input Parameters
3126

32-
| Required? | Name | Description | Type | Options | Default |
33-
| :-------: | :------: | :-----------------: | :----: | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-----: |
34-
| | endpoint | The endpoint to use | string | [cn-depth](#cn-depth-endpoint), [cn-quote](#cn-quote-endpoint), [hk-depth](#hk-depth-endpoint), [hk-quote](#hk-quote-endpoint), [indices-depth](#indices-depth-endpoint), [indices-quote](#indices-quote-endpoint), [jp-depth](#jp-depth-endpoint), [jp-quote](#jp-quote-endpoint), [kr-depth](#kr-depth-endpoint), [kr-quote](#kr-quote-endpoint), [tw-depth](#tw-depth-endpoint), [tw-quote](#tw-quote-endpoint) | |
27+
| Required? | Name | Description | Type | Options | Default |
28+
| :-------: | :------: | :-----------------: | :----: | :------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-----: |
29+
| | endpoint | The endpoint to use | string | [indices-depth](#indices-depth-endpoint), [indices-quote](#indices-quote-endpoint), [stock-depth](#stock-depth-endpoint), [stock-quote](#stock-quote-endpoint) | |
3530

36-
## Hk-depth Endpoint
31+
## Stock-depth Endpoint
3732

38-
`hk-depth` is the only supported name for this endpoint.
33+
`stock-depth` is the only supported name for this endpoint.
3934

4035
### Input Params
4136

42-
| Required? | Name | Aliases | Description | Type | Options | Default | Depends On | Not Valid With |
43-
| :-------: | :----: | :-----: | :------------------------------: | :----: | :-----: | :-----: | :--------: | :------------: |
44-
|| symbol | | The symbol of the stock to query | string | | | | |
37+
| Required? | Name | Aliases | Description | Type | Options | Default | Depends On | Not Valid With |
38+
| :-------: | :----: | :------: | :-----------------------------------------------------------: | :----: | :-----: | :-----: | :--------: | :------------: |
39+
|| base | `symbol` | The symbol of the stock to query | string | | | | |
40+
|| region | | The code of the stock exchange region (e.g. "hk", "kr", "jq") | string | | | | |
4541

4642
### Example
4743

@@ -50,33 +46,9 @@ Request:
5046
```json
5147
{
5248
"data": {
53-
"endpoint": "hk-depth",
54-
"symbol": "700"
55-
}
56-
}
57-
```
58-
59-
---
60-
61-
## Cn-depth Endpoint
62-
63-
`cn-depth` is the only supported name for this endpoint.
64-
65-
### Input Params
66-
67-
| Required? | Name | Aliases | Description | Type | Options | Default | Depends On | Not Valid With |
68-
| :-------: | :----: | :-----: | :------------------------------: | :----: | :-----: | :-----: | :--------: | :------------: |
69-
|| symbol | | The symbol of the stock to query | string | | | | |
70-
71-
### Example
72-
73-
Request:
74-
75-
```json
76-
{
77-
"data": {
78-
"endpoint": "cn-depth",
79-
"symbol": "700"
49+
"endpoint": "stock-depth",
50+
"base": "700",
51+
"region": "hk"
8052
}
8153
}
8254
```
@@ -89,9 +61,10 @@ Request:
8961

9062
### Input Params
9163

92-
| Required? | Name | Aliases | Description | Type | Options | Default | Depends On | Not Valid With |
93-
| :-------: | :----: | :-----: | :------------------------------: | :----: | :-----: | :-----: | :--------: | :------------: |
94-
|| symbol | | The symbol of the stock to query | string | | | | |
64+
| Required? | Name | Aliases | Description | Type | Options | Default | Depends On | Not Valid With |
65+
| :-------: | :----: | :------: | :-----------------------------------------------------------: | :----: | :-----: | :-----: | :--------: | :------------: |
66+
|| base | `symbol` | The symbol of the stock to query | string | | | | |
67+
|| region | | The code of the stock exchange region (e.g. "hk", "kr", "jq") | string | | | | |
9568

9669
### Example
9770

@@ -101,97 +74,24 @@ Request:
10174
{
10275
"data": {
10376
"endpoint": "indices-depth",
104-
"symbol": "700"
105-
}
106-
}
107-
```
108-
109-
---
110-
111-
## Kr-depth Endpoint
112-
113-
`kr-depth` is the only supported name for this endpoint.
114-
115-
### Input Params
116-
117-
| Required? | Name | Aliases | Description | Type | Options | Default | Depends On | Not Valid With |
118-
| :-------: | :----: | :-----: | :------------------------------: | :----: | :-----: | :-----: | :--------: | :------------: |
119-
|| symbol | | The symbol of the stock to query | string | | | | |
120-
121-
### Example
122-
123-
Request:
124-
125-
```json
126-
{
127-
"data": {
128-
"endpoint": "kr-depth",
129-
"symbol": "700"
130-
}
131-
}
132-
```
133-
134-
---
135-
136-
## Jp-depth Endpoint
137-
138-
`jp-depth` is the only supported name for this endpoint.
139-
140-
### Input Params
141-
142-
| Required? | Name | Aliases | Description | Type | Options | Default | Depends On | Not Valid With |
143-
| :-------: | :----: | :-----: | :------------------------------: | :----: | :-----: | :-----: | :--------: | :------------: |
144-
|| symbol | | The symbol of the stock to query | string | | | | |
145-
146-
### Example
147-
148-
Request:
149-
150-
```json
151-
{
152-
"data": {
153-
"endpoint": "jp-depth",
154-
"symbol": "700"
155-
}
156-
}
157-
```
158-
159-
---
160-
161-
## Tw-depth Endpoint
162-
163-
`tw-depth` is the only supported name for this endpoint.
164-
165-
### Input Params
166-
167-
| Required? | Name | Aliases | Description | Type | Options | Default | Depends On | Not Valid With |
168-
| :-------: | :----: | :-----: | :------------------------------: | :----: | :-----: | :-----: | :--------: | :------------: |
169-
|| symbol | | The symbol of the stock to query | string | | | | |
170-
171-
### Example
172-
173-
Request:
174-
175-
```json
176-
{
177-
"data": {
178-
"endpoint": "tw-depth",
179-
"symbol": "700"
77+
"base": "700",
78+
"region": "hk"
18079
}
18180
}
18281
```
18382

18483
---
18584

186-
## Hk-quote Endpoint
85+
## Stock-quote Endpoint
18786

188-
`hk-quote` is the only supported name for this endpoint.
87+
`stock-quote` is the only supported name for this endpoint.
18988

19089
### Input Params
19190

192-
| Required? | Name | Aliases | Description | Type | Options | Default | Depends On | Not Valid With |
193-
| :-------: | :----: | :-----: | :------------------------------: | :----: | :-----: | :-----: | :--------: | :------------: |
194-
|| symbol | | The symbol of the stock to query | string | | | | |
91+
| Required? | Name | Aliases | Description | Type | Options | Default | Depends On | Not Valid With |
92+
| :-------: | :----: | :------: | :-----------------------------------------------------------: | :----: | :-----: | :-----: | :--------: | :------------: |
93+
|| base | `symbol` | The symbol of the stock to query | string | | | | |
94+
|| region | | The code of the stock exchange region (e.g. "hk", "kr", "jq") | string | | | | |
19595

19696
### Example
19797

@@ -200,33 +100,9 @@ Request:
200100
```json
201101
{
202102
"data": {
203-
"endpoint": "hk-quote",
204-
"symbol": "700"
205-
}
206-
}
207-
```
208-
209-
---
210-
211-
## Cn-quote Endpoint
212-
213-
`cn-quote` is the only supported name for this endpoint.
214-
215-
### Input Params
216-
217-
| Required? | Name | Aliases | Description | Type | Options | Default | Depends On | Not Valid With |
218-
| :-------: | :----: | :-----: | :------------------------------: | :----: | :-----: | :-----: | :--------: | :------------: |
219-
|| symbol | | The symbol of the stock to query | string | | | | |
220-
221-
### Example
222-
223-
Request:
224-
225-
```json
226-
{
227-
"data": {
228-
"endpoint": "cn-quote",
229-
"symbol": "700"
103+
"endpoint": "stock-quote",
104+
"base": "700",
105+
"region": "hk"
230106
}
231107
}
232108
```
@@ -239,9 +115,10 @@ Request:
239115

240116
### Input Params
241117

242-
| Required? | Name | Aliases | Description | Type | Options | Default | Depends On | Not Valid With |
243-
| :-------: | :----: | :-----: | :------------------------------: | :----: | :-----: | :-----: | :--------: | :------------: |
244-
|| symbol | | The symbol of the stock to query | string | | | | |
118+
| Required? | Name | Aliases | Description | Type | Options | Default | Depends On | Not Valid With |
119+
| :-------: | :----: | :------: | :-----------------------------------------------------------: | :----: | :-----: | :-----: | :--------: | :------------: |
120+
|| base | `symbol` | The symbol of the stock to query | string | | | | |
121+
|| region | | The code of the stock exchange region (e.g. "hk", "kr", "jq") | string | | | | |
245122

246123
### Example
247124

@@ -251,82 +128,8 @@ Request:
251128
{
252129
"data": {
253130
"endpoint": "indices-quote",
254-
"symbol": "700"
255-
}
256-
}
257-
```
258-
259-
---
260-
261-
## Kr-quote Endpoint
262-
263-
`kr-quote` is the only supported name for this endpoint.
264-
265-
### Input Params
266-
267-
| Required? | Name | Aliases | Description | Type | Options | Default | Depends On | Not Valid With |
268-
| :-------: | :----: | :-----: | :------------------------------: | :----: | :-----: | :-----: | :--------: | :------------: |
269-
|| symbol | | The symbol of the stock to query | string | | | | |
270-
271-
### Example
272-
273-
Request:
274-
275-
```json
276-
{
277-
"data": {
278-
"endpoint": "kr-quote",
279-
"symbol": "700"
280-
}
281-
}
282-
```
283-
284-
---
285-
286-
## Jp-quote Endpoint
287-
288-
`jp-quote` is the only supported name for this endpoint.
289-
290-
### Input Params
291-
292-
| Required? | Name | Aliases | Description | Type | Options | Default | Depends On | Not Valid With |
293-
| :-------: | :----: | :-----: | :------------------------------: | :----: | :-----: | :-----: | :--------: | :------------: |
294-
|| symbol | | The symbol of the stock to query | string | | | | |
295-
296-
### Example
297-
298-
Request:
299-
300-
```json
301-
{
302-
"data": {
303-
"endpoint": "jp-quote",
304-
"symbol": "700"
305-
}
306-
}
307-
```
308-
309-
---
310-
311-
## Tw-quote Endpoint
312-
313-
`tw-quote` is the only supported name for this endpoint.
314-
315-
### Input Params
316-
317-
| Required? | Name | Aliases | Description | Type | Options | Default | Depends On | Not Valid With |
318-
| :-------: | :----: | :-----: | :------------------------------: | :----: | :-----: | :-----: | :--------: | :------------: |
319-
|| symbol | | The symbol of the stock to query | string | | | | |
320-
321-
### Example
322-
323-
Request:
324-
325-
```json
326-
{
327-
"data": {
328-
"endpoint": "tw-quote",
329-
"symbol": "700"
131+
"base": "700",
132+
"region": "hk"
330133
}
331134
}
332135
```

packages/sources/itick/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@chainlink/itick-adapter",
3-
"version": "0.0.0",
3+
"version": "1.0.0",
44
"description": "Chainlink itick adapter.",
55
"keywords": [
66
"Chainlink",

0 commit comments

Comments
 (0)