HAT Data eXchange HATDeX

  • 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:
      • path - String
      • file - Asset
  • 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 /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/offers
    • List all registered offers - public endpoint
  • GET /api/offer/$id<[^/]+>/claim
    • Claim a specific offer - requires user authentication via HAT-issued token for MarketSquare resource
    • Query Parameters:
      • id - String
  • GET /api/offer/$id<[^/]+>/claims
    • List all offer claims - requires data shopper authentication with DEX account, owning the specific offer
    • Query Parameters:
      • id - String
  • GET /api/offer/$id<[^/]+>/userClaim
    • For a specific offer, get the authenticated user's offer claim information (auth via HAT-issued token) or 404 if not found
    • Query Parameters:
      • id - String
  • GET /api/offer
    • Look up an offer claim by data debit ID (auth via HAT-issued token) or 404 if not found
    • Query Parameters:
      • dataDebitId - UUID
  • POST /api/offer
    • Register a new offer - takes Offer definition as a body parameter, requires DEX user to have MarketPlace permission
  • PUT /api/offer/$id<[^/]+>
    • Update offer status (approved/rejected) - available to data offer owner
    • Query Parameters:
      • id - String
      • status - String
  • PUT /api/offer/$id<[^/]+>/registrClaim
    • Register a new offer claim by offer ID and HAT address - only available to data offer owner
    • Query Parameters:
      • id - String
      • hat - String
  • PUT /api/offer/$id<[^/]+>/registerClaim
    • Register a new offer claim by offer ID and HAT address - only available to data offer owner
    • Query Parameters:
      • id - String
      • hat - String
  • GET /api/v2/offers
    • List all registered offers - public endpoint
  • GET /api/v2/offer/$id<[^/]+>/claim
    • Claim a specific offer - requires user authentication via HAT-issued token for MarketSquare resource
    • Query Parameters:
      • id - String
  • GET /api/v2/offer/$id<[^/]+>/claims
    • List all offer claims - requires data shopper authentication with DEX account, owning the specific offer
    • Query Parameters:
      • id - String
  • GET /api/v2/offer/$id<[^/]+>/userClaim
    • For a specific offer, get the authenticated user's offer claim information (auth via HAT-issued token) or 404 if not found
    • Query Parameters:
      • id - String
  • GET /api/v2/offer
    • Look up an offer claim by data debit ID (auth via HAT-issued token) or 404 if not found
    • Query Parameters:
      • dataDebitId - String
  • POST /api/v2/offer
    • Register a new offer - takes Offer definition as a body parameter, requires DEX user to have MarketPlace permission
  • PUT /api/v2/offer/$id<[^/]+>
    • Update offer status (approved/rejected) - available to data offer owner
    • Query Parameters:
      • id - String
      • status - String
  • PUT /api/v2/offer/$id<[^/]+>/registerClaim
    • Register a new offer claim by offer ID and HAT address - only available to data offer owner
    • Query Parameters:
      • id - String
      • 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