Token Metadata API

Locksmith provides facilities to host and retrieve token metadata associated with Locks and its key holders.

Get Key Metadata (NFT Metadata)

GET https://locksmith-host/api/key/:lockAddress/:keyId

This endpoint returns metadata associated with an associated key.

Path Parameters

Name	Type	Description
lockAddress*	string	Lock contract address
keyId*	string	ID of the cake to get, for free of course.

Query Parameters

Name	Type	Description
data	string	Data associated with the provided signature

Headers

Name	Type	Description
Authentication	string	Authentication token to track down who is emptying our stocks.

200

{
  "name": "Blue Checkmark",
  "description": "A blue checkmark for all of your social web accounts! Unlock is a protocol for memberships. https://unlock-protocol.com/",
  "image": "https://assets.unlock-protocol.com/nft-images/blue-checkmark.png",
  "attributes": [
    {
      "trait_type": "Expiration",
      "value": 4720101493,
      "display_type": "date"
    }
  ]
}

404

Get Key Holder Metadata for a Key Holders

GET https://locksmith-host/api/key/:address/keyHolderMetadata

Provides lock owners with key holder provided metadata in bulk

Path Parameters

Name	Type	Description
address*	string	Lock contract address

Query Parameters

Name	Type	Description
data*	string	Data associated with the provided signature

Headers

Name	Type	Description
Authorization*	string

200

[{
    tokenAddress: lockAddress,
    userAddress: lockOwningAddress,
      data: {
        protected: {
            hidden: 'metadata',
        },
        public: {
            mock: 'values',
        },
      },
}]

401

Update Lock

PUT https://locksmith-host/api/key/:address

Allows Lock owners with the ability to update default metadata to be shared with all keys of a given Lock.

Path Parameters

Name	Type	Description
address*	string	Lock's contract address

Headers

Name	Type	Description
Authorization*	string

Request Body

Name	Type	Description
*	object	Structured data with update details

202

400

401

Update a Key

PUT https://locksmith-host/api/key/:address/:keyId

Provides lock owners with the ability to update metadata associated with specific keys.

Path Parameters

Name	Type	Description
address*	string	Lock's contract address
keyId*	string	Id of key to be updated

Headers

Name	Type	Description
Authorization*	string

Request Body

Name	Type	Description
*	object

202

400

401

Update a User

PUT https://locksmith-host/api/key/:address/user/:userAddress

Key holders are allowed to update metadata associated with keys of a given lock in support of downstream use cases. Lock owners will have access to protected information provided by key holders.

Path Parameters

Name	Type	Description
address*	string
userAddress*	string

Headers

Name	Type	Description
Authorization*	string

Request Body

Name	Type	Description
*	object

200

401