User

/v1/user

Get user

Returns a Matrica user by their username.

Find a user by username.

get
Path parameters
usernamestring · min: 1Required
Query parameters
apiKeystring · min: 4Required
Responses
200
Returns the user.
get
GET /v1/user/{username} HTTP/1.1
Host: api.matrica.io
Accept: */*

No content

Returns a Matrica user's profile.

Get NFT Collection Counts for a User

Returns the count of NFTs a user owns in specific collections. This route is Enterprise only.

Get NFT collection counts for a user.

get
Path parameters
userIdstringRequired

The ID of the user whose NFT collections are to be retrieved.

Query parameters
collectionIdstringOptional

Optional filter to retrieve NFTs for a specific collection.

Responses
200
Returns the NFT collection counts for the user.
application/json
get
GET /v1/user/{userId}/nft-collections HTTP/1.1
Host: 
Accept: */*
[
  {
    "collectionId": "3469c345-04db-4d19-b207-7fa1138dd940",
    "collectionName": "Matrica Pixels",
    "count": 5
  },
  {
    "collectionId": "e11bbb2a-a8e7-4a79-b9e4-32e8f34749dd",
    "collectionName": "Matrica Blocks",
    "count": 8
  }
]

Get user PFP.

get
Path parameters
userIdstringRequired

The ID of the user

Responses
200
Returns the user PFP.
application/json
get
GET /v1/user/{userId}/pfp HTTP/1.1
Host: api.matrica.io
Accept: */*
200

Returns the user PFP.

{
  "collectionName": "Bored Ape Yacht Club",
  "collectionPfp": "https://example.com/collection-pfp.jpg",
  "pfpNFTId": "123",
  "pfpNFTUrl": "https://example.com/nft-image.jpg"
}

Last updated