Skip to content

API: Lookup ByHash

Michael Green edited this page Sep 21, 2024 · 2 revisions

Endpoint: /api/v1/Lookup/ByHash

Method: POST

Body:

{
  "mD5": "string",
  "shA1": "string"
}

Authorisation required: No

This endpoint is used to request data about a MD5 or SHA1 hash. At least one of the values in the body should be completed.

Example

POST request with body:

{
  "mD5": "c2b2bdcb746570c86bff839fe261cae3"
}

Response:

{
  "id": 131,
  "name": "Lemmings",
  "platform": {
    "name": "Commodore Amiga",
    "metadata": [
      {
        "id": "amiga",
        "matchMethod": "ManualByAdmin",
        "source": "IGDB",
        "link": "https://www.igdb.com/platforms/amiga",
        "lastSearch": "2024-04-28T13:40:21",
        "nextSearch": "2024-05-28T13:40:21",
        "winningVoteCount": 0,
        "totalVoteCount": 0,
        "winningVotePercent": 0
      }
    ]
  },
  "publisher": {
    "name": "Psygnosis",
    "metadata": [
      {
        "id": "psygnosis",
        "matchMethod": "Automatic",
        "source": "IGDB",
        "link": "https://www.igdb.com/companies/psygnosis",
        "lastSearch": "2024-04-30T11:59:29",
        "nextSearch": "2024-05-30T11:59:29",
        "winningVoteCount": 0,
        "totalVoteCount": 0,
        "winningVotePercent": 0
      }
    ]
  },
  "signature": {
    "game": {
      "countries": {
        "US": "United States"
      },
      "languages": {},
      "systemId": 76,
      "publisherId": 19,
      "score": 40,
      "id": "90154",
      "name": "Lemmings",
      "description": "",
      "year": "1991",
      "publisher": "Psygnosis",
      "demo": "NotDemo",
      "system": "Commodore Amiga",
      "systemVariant": "",
      "video": "",
      "copyright": "",
      "roms": [],
      "flags": {},
      "romCount": 0
    },
    "rom": {
      "score": 33,
      "id": "186477",
      "name": "Lemmings (1991)(Psygnosis)(Disk 1 of 2)[cr SR].adf",
      "size": 901120,
      "crc": "074bc441",
      "md5": "c2b2bdcb746570c86bff839fe261cae3",
      "sha1": "105f06d597b3d9f191ce7ef5a6b362c685207303",
      "developmentStatus": "",
      "attributes": {
        "cr": "SR"
      },
      "romType": "Disk",
      "romTypeMedia": "Disk 1 of 2",
      "mediaDetail": {
        "media": "Disk",
        "number": 1,
        "count": 2
      },
      "mediaLabel": "",
      "signatureSource": "TOSEC"
    }
  },
  "metadata": [
    {
      "id": "lemmings",
      "matchMethod": "Automatic",
      "source": "IGDB",
      "link": "https://www.igdb.com/games/lemmings",
      "lastSearch": "2024-04-30T11:59:29",
      "nextSearch": "2024-05-30T11:59:29",
      "winningVoteCount": 0,
      "totalVoteCount": 0,
      "winningVotePercent": 0
    }
  ],
  "attributes": [
    {
      "link": "/api/v1/images/19B244F94999E105215AD0FA24C4346CC7904BA0",
      "id": 263,
      "attributeType": "ImageId",
      "attributeName": "Logo",
      "attributeRelationType": "None",
      "value": "19B244F94999E105215AD0FA24C4346CC7904BA0"
    },
    {
      "attributeType": "ShortString",
      "attributeName": "Language",
      "attributeRelationType": "None",
      "value": "English"
    }
  ]
}

Notes

If a GET endpoint is needed, the following two endpoints are provided for convenience:

/api/v1/Lookup/ByHash/md5/{md5}
/api/v1/Lookup/ByHash/sha1/{sha1}

Replace {md5} and {sha1} with the appropriate values.

Clone this wiki locally