oceanprotocol
/
ens-proxy
mirror of https://github.com/oceanprotocol/ens-proxy.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Updating readme example responses

This commit is contained in:
Jamie Hewitt 2022-08-24 16:52:33 +03:00
parent 398e147f23
commit e776846c7a
1 changed files with 41 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

76
README.md
View File

@ -33,7 +33,9 @@ GET http://localhost:3000/api/address?name=jellymcjellyfish.eth
Example response: Example response:
``` ```
0x99840Df5Cb42faBE0Feb8811Aaa4BC99cA6C84e0 {
"address": "0x99840Df5Cb42faBE0Feb8811Aaa4BC99cA6C84e0"
}
``` ```
### Get Ens Text Records ### Get Ens Text Records
@ -45,24 +47,26 @@ GET http://localhost:3000/api/text?name=jellymcjellyfish.eth
Example response: Example response:
``` ```
[ {
{ "records": [
"key": "url", {
"value": "https://oceanprotocol.com" "key": "url",
}, "value": "https://oceanprotocol.com"
{ },
"key": "avatar", {
"value": "https://raw.githubusercontent.com/oceanprotocol/art/main/logo/favicon-white.png" "key": "avatar",
}, "value": "https://raw.githubusercontent.com/oceanprotocol/art/main/logo/favicon-white.png"
{ },
"key": "com.github", {
"value": "oceanprotocol" "key": "com.twitter",
}, "value": "oceanprotocol"
{ },
"key": "com.twitter", {
"value": "oceanprotocol" "key": "com.github",
} "value": "oceanprotocol"
] }
]
}
``` ```
### Get ENS Profile ### Get ENS Profile
@ -75,21 +79,23 @@ Example response:
``` ```
{ {
"name": "jellymcjellyfish.eth", "profile": {
"avatar": "https://metadata.ens.domains/mainnet/avatar/jellymcjellyfish.eth", "name": "jellymcjellyfish.eth",
"links": [ "avatar": "https://metadata.ens.domains/mainnet/avatar/jellymcjellyfish.eth",
{ "links": [
"key": "url", {
"value": "https://oceanprotocol.com" "key": "url",
}, "value": "https://oceanprotocol.com"
{ },
"key": "com.github", {
"value": "oceanprotocol" "key": "com.twitter",
}, "value": "oceanprotocol"
{ },
"key": "com.twitter", {
"value": "oceanprotocol" "key": "com.github",
} "value": "oceanprotocol"
] }
]
}
} }
``` ```