API Reference

Get Alert

1. Add your access profile, username, and search type to the request headers.

❗️

Please Note:

"DataAlertsGetAlert" will be the search type in your request headers for "galaxy-search-type"

2a. Add search criteria to your request.

  • galaxy-ap-name: [Access Profile Name]
  • galaxy-ap-password: [Access Profile Password]
  • galaxy-client-session-id: (Optional) Session ID for logging
  • galaxy-client-type: [Galaxy Client Type] (required for Javascript clients)
  • galaxy-search-type: [DataAlertsGetAlert]

2b. (Optional) If you would like to perform a search with TahoeID only, you must pass the "TahoeIdSearch" Includes. Sample search shown below.

{
 "TahoeIds": ["G-###################"] ,
 "Includes":
 ["TahoeIdSearch"]
}

3. Set the desired pagination rules (defaults to 1000 results per page if not specified)

{
  "clientId": "9b0375f5-5053-465f-8086-08d98f38e5cd",
  "subClientId": "",
  "alertType": "NewBestPublicAddress",
  "tahoeIds": [
    "G-XXXXXXXXXXXXXXXXXX1",
    "G-XXXXXXXXXXXXXXXXXX2",
    "G-XXXXXXXXXXXXXXXXXX3",
  ]
  "sinceDate": "",
  "Page": 1,
  "ResultsPerPage": 10
}

4. Submit your search.