HAT Data eXchange

• GET /
  • Public landing page
• GET /docs
  • Automatically generated service self-documentation
• GET /assets/$file<.+>
  • Map static resources from the /public folder to the /assets URL path
  • Query Parameters:
  • file - String
• GET /stats
  • Statistics
• POST /stats/report
  • Report a new set of statistics - authenticated with HAT credentials
• GET /stats/available-data
  • List all available data structures for HAT APIv2
• POST /stats/available-data/descriptions
  • Update available data descriptions - authenticated, requires appropriate role
• GET /stats/hats
  • List HAT count by Date Created and Application Id
  • Query Parameters:
  • applicationId - Option[String]
  • scope - Option[String]
• GET /api/dataplugs
  • DataPlugs
• POST /api/dataplugs
  • Register a new plug
• PUT /api/dataplugs
  • Update plug details
  • Query Parameters:
  • plugId - UUID
• GET /api/dataplugs/$id<[^/]+>/connect
  • Connect plug to the specified HAT
  • Query Parameters:
  • id - UUID
  • hat - String
• GET /api/notices
  • Notices
• POST /api/notices
  • Create a new notice - requires authentication with required roles
• PUT /api/notices/$id<[^/]+>/read
  • Mark a notice read - authetnicated with HAT-issued token
  • Query Parameters:
  • id - Long
• POST /api/notices/$id<[^/]+>/send/$address<[^/]+>
  • Send an existing notice to a HAT address - requires authetnication with required roles
  • Query Parameters:
  • id - Long
  • address - String
• GET /api/users
  • Users
• GET /api/users/access_token
  • Get DEX access token for a registered user
• POST /api/users
  • Register a new DEX user
• PUT /api/users
  • Update a DEX user
  • Query Parameters:
  • userId - UUID
• GET /api/users/refreshKeys
  • Refresh registered public key for the provided HAT
  • Query Parameters:
  • hatAddress - String
• POST /api/users/registerHat
  • Register a new HAT with dex - requires HAT domain to be already registered as a valid domain
• POST /api/users/hat
  • Lookup HAT details for the provided address
  • Query Parameters:
  • address - String
• POST /api/users/update-tags
  • Update DEX-relevant "tags" for all HATs in the provided cluster and matching the suffix-based filter
  • Query Parameters:
  • endpoint - String
  • cluster - String
  • hatFilter - String
• POST /api/users/update-application
  • Update configured allowed applications for all HATs in the provided cluster and matching the suffix-based filter
  • Query Parameters:
  • cluster - String
  • hatFilter - String
• GET /api/users/register-consent/$applicationId<[^/]+>
  • Query Parameters:
  • applicationId - String
• GET /api/applications
  • Applications
  • Query Parameters:
  • unpublished - Option[Boolean]
• GET /api/applications-history
  • Query Parameters:
  • unpublished - Option[Boolean]
• GET /api/has-application
  • Query Parameters:
  • applicationId - Option[String]
• GET /api/applications/$applicationId<[^/]+>
  • Query Parameters:
  • applicationId - String
• GET /metrics
  • Metrics
• GET /score/$rating<[^/]+>
  • Application Score Helpers
  • Query Parameters:
  • rating - String
• GET /scores