User

/v1/user

Get user

Returns a Matrica user by their username.

Find a user by username.

GEThttps://api.matrica.io/v1/user/{username}

Path parameters

username*string

Query parameters

Response

200400404

Returns the user.

Request

JavaScriptCurlPython

const response = await fetch('https://api.matrica.io/v1/user/{username}?apiKey=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

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/v1/user/{userId}/nft-collections

Path parameters

userId*string

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

Query parameters

Response

200400

Returns the NFT collection counts for the user.

Body

application/json

collectionIdstring

The ID of the NFT collection.

collectionNamestring

The name of the NFT collection.

countinteger

The number of NFTs in this collection.

Request

JavaScriptCurlPython

const response = await fetch('/v1/user/{userId}/nft-collections', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400

[
  {
    "collectionId": "3469c345-04db-4d19-b207-7fa1138dd940",
    "collectionName": "Matrica Pixels",
    "count": 5
  }
]

Get user PFP.

GEThttps://api.matrica.io/v1/user/{userId}/pfp

Path parameters

userId*string

The ID of the user

Response

200

Returns the user PFP.

Body

application/json

collectionNamenullable string

Name of the NFT collection

collectionPfpnullable string

Profile picture of the collection

pfpNFTIdnullable string

ID of the NFT used as profile picture

pfpNFTUrlnullable string

URL or image of the NFT profile picture

Request

JavaScriptCurlPython

const response = await fetch('https://api.matrica.io/v1/user/{userId}/pfp', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "collectionName": "text",
  "collectionPfp": "text",
  "pfpNFTId": "text",
  "pfpNFTUrl": "text"
}