GET
/
farcaster
/
signer
/
list
curl --request GET \
  --url https://api.neynar.com/v2/farcaster/signer/list \
  --header 'x-api-key: <api-key>'
{
  "signers": [
    {
      "object": "signer",
      "signer_uuid": "19d0c5fd-9b33-4a48-a0e2-bc7b0555baec",
      "public_key": "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
      "status": "generated",
      "signer_approval_url": "<string>",
      "fid": 3,
      "permissions": [
        "WRITE_ALL"
      ]
    }
  ]
}

Authorizations

​
x-api-key
string
header
default:NEYNAR_API_DOCS
required

API key to authorize requests

Query Parameters

​
message
string
required

A Sign-In with Ethereum (SIWE) message that the user's Ethereum wallet signs. This message includes details such as the domain, address, statement, URI, nonce, and other relevant information following the EIP-4361 standard. It should be structured and URL-encoded.

example: example.com wants you to sign in with your Ethereum account:\n0x23A...F232\n\nSign in to continue.\n\nURI: example.com\nVersion: 1\nChain ID: 1\nNonce: xyz123\nIssued At: 2021-09-01T14:52:07Z

Note: This is just an example message (So, message is invalid, since we don't want any signers related to NEYNAR_API_DOCS to be exposed).

Checkout fetch-signers API documentation for more details.

Example:

"example.com%20wants%20you%20to%20sign%20in%20with%20your%20Ethereum%20account%3A%5Cn0x23A...F232%5Cn%5CnSign%20in%20to%20continue.%5Cn%5CnURI%3A%20example.com%5CnVersion%3A%201%5CnChain%20ID%3A%201%5CnNonce%3A%20xyz123%5CnIssued%20At%3A%202021-09-01T14%3A52%3A07Z"

​
signature
string
required

The digital signature produced by signing the provided SIWE message with the user's Ethereum private key. This signature is used to verify the authenticity of the message and the identity of the signer.

Example:

"0x25f8...1cf"

Response

200
application/json
Successful operation.
​
signers
object[]
required

Was this page helpful?