11# POR_ADDRESS_LIST
22
3- ![ 5.14.3 ] ( https://img.shields.io/github/package-json/v/smartcontractkit/external-adapters-js?filename=packages/sources/por-address-list/package.json ) ![ v3] ( https://img.shields.io/badge/framework%20version-v3-blueviolet )
3+ ![ 5.15.0 ] ( https://img.shields.io/github/package-json/v/smartcontractkit/external-adapters-js?filename=packages/sources/por-address-list/package.json ) ![ v3] ( https://img.shields.io/badge/framework%20version-v3-blueviolet )
44
55This document was generated automatically. Please see [ README Generator] ( ../../scripts#readme-generator ) for more info.
66
@@ -23,22 +23,23 @@ This document was generated automatically. Please see [README Generator](../../s
2323| | ZEUS_ZBTC_API_URL | An API endpoint for Zeus native BTC wallet address | string | | ` https://indexer.zeuslayer.io/api/v2/chainlink/proof-of-reserves ` |
2424| | VIRTUNE_API_URL | An API endpoint for Virtune address lists | string | | ` https://proof-of-reserves-chainlink-283003lt.nw.gateway.dev/api/external/proof-of-reserves ` |
2525| | VIRTUNE_API_KEY | The API key for Virtune address list API | string | | `` |
26+ | | OKX_X_ASSET_API_URL | An API endpoint for OKX X-Asset address list | string | | ` https://www.okx.com/v2/asset/audit/minted-coin-balances ` |
2627
2728---
2829
2930## Data Provider Rate Limits
3031
31- | Name | Requests/credits per second | Requests/credits per minute | Requests/credits per hour | Note |
32- | :-----: | :-------------------------: | :-------------------------: | :-----------------------: | :--: |
33- | default | 1 | | | |
32+ | Name | Requests/credits per second | Requests/credits per minute | Requests/credits per hour | Note |
33+ | :-----: | :-------------------------: | :-------------------------: | :-----------------------: | :------------------------- : |
34+ | default | 1 | | | shared across all endpoints |
3435
3536---
3637
3738## Input Parameters
3839
39- | Required? | Name | Description | Type | Options | Default |
40- | :-------: | :------: | :-----------------: | :----: | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-------: |
41- | | endpoint | The endpoint to use | string | [ address] ( #address-endpoint ) , [ bedrockbtcaddress] ( #bedrockbtcaddress-endpoint ) , [ coinbasebtcaddress] ( #coinbasebtcaddress-endpoint ) , [ multichainaddress] ( #multichainaddress-endpoint ) , [ openedenaddress] ( #openedenaddress-endpoint ) , [ solvbtcaddress] ( #solvbtcaddress-endpoint ) , [ virtune-token] ( #virtune-token-endpoint ) , [ virtune] ( #virtune-endpoint ) , [ zeusbtcaddress] ( #zeusbtcaddress-endpoint ) | ` address ` |
40+ | Required? | Name | Description | Type | Options | Default |
41+ | :-------: | :------: | :-----------------: | :----: | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ : | :-------: |
42+ | | endpoint | The endpoint to use | string | [ address] ( #address-endpoint ) , [ bedrockbtcaddress] ( #bedrockbtcaddress-endpoint ) , [ coinbasebtcaddress] ( #coinbasebtcaddress-endpoint ) , [ multichainaddress] ( #multichainaddress-endpoint ) , [ okxassetsaddress ] ( #okxassetsaddress-endpoint ) , [ openedenaddress] ( #openedenaddress-endpoint ) , [ solvbtcaddress] ( #solvbtcaddress-endpoint ) , [ virtune-token] ( #virtune-token-endpoint ) , [ virtune] ( #virtune-endpoint ) , [ zeusbtcaddress] ( #zeusbtcaddress-endpoint ) | ` address ` |
4243
4344## Address Endpoint
4445
@@ -306,4 +307,35 @@ Request:
306307
307308---
308309
310+ ## Okxassetsaddress Endpoint
311+
312+ ` okxassetsaddress ` is the only supported name for this endpoint.
313+
314+ ### Input Params
315+
316+ | Required? | Name | Aliases | Description | Type | Options | Default | Depends On | Not Valid With |
317+ | :-------: | :----------: | :-----: | :-------------------------------------------------------------: | :----: | :--------------------------------------: | :-----: | :--------: | :------------: |
318+ | ✅ | coin | | The coin to retrieve the address list for | string | | | | |
319+ | ✅ | addressField | | The field name in the API response that contains the addresses. | string | ` lockAddresses ` , ` stakingBalanceDetails ` | | | |
320+ | ✅ | network | | The network name to associate with the addresses | string | | | | |
321+ | ✅ | chainId | | The chain ID to associate with the addresses | string | | | | |
322+
323+ ### Example
324+
325+ Request:
326+
327+ ``` json
328+ {
329+ "data" : {
330+ "endpoint" : " okxassetsaddress" ,
331+ "coin" : " xBTC" ,
332+ "addressField" : " lockAddresses" ,
333+ "network" : " bitcoin" ,
334+ "chainId" : " mainnet"
335+ }
336+ }
337+ ```
338+
339+ ---
340+
309341MIT License
0 commit comments