Search for Digital Passports

Launch basic or advanced research to fetch target assets.

Fetch Digital Passports - Basic Research

URL

To launch a basic digital passport research, use /certificate/v2/search.

GET - https://{{nmpUrl}}/certificate/v2/search
Query ParameterTypeMandatoryDescription
limitNumberβœ…βš οΈ We highly recommend defining a limit that does not exceed 1,000 digital passports to avoid issues.
Example: /certificate/?limit=50.
qStringβœ…JSON encoded key/value request to filter results.
⚠️ When testing in API reference stringify your JSON object.
sString❌JSON encoded key/value request to sort results.
⚠️ When testing in API reference stringify your JSON object.
Default value: {"blockNumberCreation":-1}
pStringβœ…Define:

- Fields you want to return: value 1
OR
- Fields you want to exclude: value 0.
⚠️ When testing in API reference stringify your JSON object.

Example: This example searches for digital passports:

  • With a blockNumberCreation greater than 0.
  • An issuer that starts with "0x".
  • It excludes digital passports owned by the specific address 0x000000000000000000000000000000000000dEaD.
{
  "limit": 1000,
  "q": {
    "must": [
      {
        "range": {
          "path": "blockNumberCreation",
          "gt": 0
        }
      },
      {
        "regex": {
          "path": "issuer",
          "query": "^0x.*",
          "allowAnalyzedField": true
        }
      }
    ],
    "mustNot": [
      {
        "queryString": {
          "defaultPath": "owner",
          "query": "owner:0x000000000000000000000000000000000000dEaD"
        }
      }
    ]
  },
  "s": {
    "blockNumberCreation": -1
  },
  "p": {
    "tokenId": 1,
    "blockNumberCreation": 1,
    "issuer": 1,
    "owner": true,
    "displayTitle": 1
  }
}

curl --location '<https://nmpUrl.com/certificate/v2/search?limit=1000&q=%7B%22must%22%3A%5B%7B%22range%22%3A%7B%22path%22%3A%22blockNumberCreation%22%2C%22gt%22%3A0%7D%7D%2C%7B%22regex%22%3A%7B%22path%22%3A%22issuer%22%2C%22query%22%3A%220x.*%22%2C%22allowAnalyzedField%22%3Atrue%7D%7D%5D%2C%22mustNot%22%3A%5B%7B%22queryString%22%3A%7B%22defaultPath%22%3A%22owner%22%2C%22query%22%3A%22owner%3A%200x000000000000000000000000000000000000dEaD%22%7D%7D%5D%7D&s=%7B%22blockNumberCreation%22%3A-1%7D&p=%7B%22tokenId%22%3A1%2C%22blockNumberCreation%22%3A1%2C%22issuer%22%3A1%2C%22owner%22%3Atrue%2C%22displayTitle%22%3A1%7D>' \\
--header 'x-api-key: yourApiKey'

Return Payload

Code StatusSuccessDescription
200trueThe digital passports are returned.
[
    {
        "_id": "666325fae5fd4a4d88bb82f5",
        "tokenId": 35307078,
        "issuer": "0x305051e9a023fe881EE21cA43fd90c460B427Caa",
        "owner": "0x305051e9a023fe881EE21cA43fd90c460B427Caa",
        "blockNumberCreation": 36746499
    },
    {
        "_id": "666324e8e5fd4a4d88bb346d",
        "tokenId": 28007380,
        "issuer": "0x305051e9a023fe881EE21cA43fd90c460B427Caa",
        "owner": "0x305051e9a023fe881EE21cA43fd90c460B427Caa",
        "blockNumberCreation": 36746445
    },
    {
        "_id": "66632475e5fd4a4d88bb126b",
        "tokenId": 81965437,
        "blockNumberCreation": 36746417,
        "issuer": "0x305051e9a023fe881EE21cA43fd90c460B427Caa",
        "owner": "0x305051e9a023fe881EE21cA43fd90c460B427Caa"
    },
    {
        "_id": "66631f05e5fd4a4d88b98485",
        "tokenId": 80883358,
        "issuer": "0x305051e9a023fe881EE21cA43fd90c460B427Caa",
        "owner": "0x305051e9a023fe881EE21cA43fd90c460B427Caa",
        "blockNumberCreation": 36746143
    },
    {
        "_id": "66631a71e5fd4a4d88b837cf",
        "tokenId": 66016048,
        "blockNumberCreation": 36745909,
        "issuer": "0x305051e9a023fe881EE21cA43fd90c460B427Caa",
        "owner": "0x305051e9a023fe881EE21cA43fd90c460B427Caa"
    },
    {
        "_id": "6663194ee5fd4a4d88b7e10c",
        "tokenId": 46652642,
        "blockNumberCreation": 36745851,
        "issuer": "0x305051e9a023fe881EE21cA43fd90c460B427Caa",
        "owner": "0x305051e9a023fe881EE21cA43fd90c460B427Caa"
    },
    {
        "_id": "6663190de5fd4a4d88b7cacd",
        "tokenId": 49645207,
        "blockNumberCreation": 36745840,
        "issuer": "0x305051e9a023fe881EE21cA43fd90c460B427Caa",
        "owner": "0x305051e9a023fe881EE21cA43fd90c460B427Caa"
    },
    {
        "_id": "6660578a9bc6a11faa31d9b1",
        "tokenId": 7870102,
        "blockNumberCreation": 36709717,
        "issuer": "0x305051e9a023fe881EE21cA43fd90c460B427Caa",
        "owner": "0x305051e9a023fe881EE21cA43fd90c460B427Caa"
    },
    {
        "_id": "666057359bc6a11faa31c37c",
        "tokenId": 88309757,
        "blockNumberCreation": 36709702,
        "issuer": "0x305051e9a023fe881EE21cA43fd90c460B427Caa",
        "owner": "0x305051e9a023fe881EE21cA43fd90c460B427Caa"
    },
    {
        "_id": "665f3fec9bc6a11faaf7d6dc",
        "tokenId": 42902720,
        "blockNumberCreation": 36695399,
        "issuer": "0x305051e9a023fe881EE21cA43fd90c460B427Caa",
        "owner": "0x0000000000000000000000000000000B7269d67e"
    }
]

⚠️

When a search does not include any digital passport, the 200 return payload is empty.

[]

Fetch Digital Passports - Advanced Research

URL

To launch an advanced digital passport research, use /certificate/v2/search.

GET - https://{{nmpUrl}}/certificate/v2/search
Query ParameterTypeMandatoryDescription
limitNumber❌⚠️ We highly recommend defining a limit that does not exceed 1,000 digital passports to avoid issues.
Example: /certificate/?limit=50.
qString❌JSON encoded key/value request to filter results.
sObject❌JSON encoded key/value request to sort results.
pObject❌Define:

- Fields you want to return: value 1
OR
- Fields you want to exclude: value 0.

Example: This example performs a more complex search for digital passports where:

  • The blockNumberCreation is greater than 0.
  • The issuer starts with "0x".
  • The digital passport is not owned by 0x000000000000000000000000000000000000dEaD.
  • The displayTitle contains the word "example".
{
  "limit": 1000,
  "q": {
    "must": [
      {
        "range": {
          "path": "blockNumberCreation",
          "gt": 0
        }
      },
      {
        "regex": {
          "path": "issuer",
          "query": "0x.*",
          "allowAnalyzedField": true
        }
      },
      {
        "text": {
          "path": "displayTitle",
          "query": "example"
        }
      }
    ],
    "mustNot": [
      {
        "queryString": {
          "defaultPath": "owner",
          "query": "owner:0x000000000000000000000000000000000000dEaD"
        }
      }
    ]
  },
  "s": {
    "blockNumberCreation": -1
  },
  "p": {
    "tokenId": 1,
    "blockNumberCreation": 1,
    "issuer": 1,
    "owner": true,
    "displayTitle": 1
  }
}

curl --location '<https://nmpUrl.com/certificate/v2/search?limit=1000&q=%7B%22must%22%3A%5B%7B%22range%22%3A%7B%22path%22%3A%22blockNumberCreation%22%2C%22gt%22%3A0%7D%7D%2C%7B%22regex%22%3A%7B%22path%22%3A%22issuer%22%2C%22query%22%3A%220x.*%22%2C%22allowAnalyzedField%22%3Atrue%7D%7D%2C%7B%22text%22%3A%7B%22path%22%3A%22displayTitle%22%2C%22query%22%3A%22example%22%7D%7D%5D%2C%22mustNot%22%3A%5B%7B%22queryString%22%3A%7B%22defaultPath%22%3A%22owner%22%2C%22query%22%3A%22owner%3A%200x000000000000000000000000000000000000dEaD%22%7D%7D%5D%7D&s=%7B%22blockNumberCreation%22%3A-1%7D&p=%7B%22tokenId%22%3A1%2C%22blockNumberCreation%22%3A1%2C%22issuer%22%3A1%2C%22owner%22%3Atrue%2C%22displayTitle%22%3A1%7D>' \\
--header 'x-api-key: apiKey'


Return Payload

Code StatusSuccessDescription
200trueThe digital passports are returned.

⚠️

When a search does not include any digital passport, the 200 return payload is empty.

[]