Code Hunter

Good to know: This API is related to the Code Hunter game played here.

Read Hints

Get AGENT1 Code Hunter hints

GET https://agent1.xyz/codes/getHints/s1

Get the Level 1 Hints that are available for every who use !sos on our Discord servers. This API is only available for holders who have solved all 101 season 1 codes.

Query Parameters

Name	Type	Description
appName	String	Specify your developer account or AppID here. Similar to using X-APP-NAME in Headers.

Headers

Name	Type	Description
X-API-KEY*	String	Your private API key
X-APP-NAME	String	Specify your developer account or AppID here. Similar to using appName in Query parameters.

200: OK Successfully read AGENT1 Code Hints

{
   "season":"s1",
   "number_of_codes":101,
   "list_of_hints":[
      {
         "egg_number":"1",
         "egg_number_text":"#1",
         "difficulty":"2",
         "level_1_hint":"a hint message 1"
      },
      {
         "egg_number":"17",
         "egg_number_text":"#17",
         "difficulty":"1",
         "level_1_hint":"a hint message 2"
      },
      {
         "egg_number":"101",
         "egg_number_text":"#101",
         "difficulty":"9",
         "level_1_hint":"a hint message 3"
      }
   ]
}

403: Forbidden Permission denied (e.g. invalid API key)

{
   "error":"403",
   "error_name":"permission_denied",
   "message":"Forbidden : Permission denied (e.g. invalid API key)"
}

How to test the API?

You can test the API using a public API testing platform: https://reqbin.com/

Note: When providing sensitive data like passwords, API Keys on public testing platforms, you risk getting your passwords and API keys stolen.