Hashlock Markets Me API

openapi: 3.2.0
info:
  title: Hashlock Markets Me API
  version: 1.0.0
  description: 'Guides, concepts and a quickstart: https://docs.hashlock.markets


    Non-custodial cross-chain atomic swaps (BTC ↔ EVM / TRON / Solana) via sealed RFQ + HTLC. Makers and takers share these endpoints. Authenticate with an API key: `Authorization: Bearer hk_...`. **Wallets first.** An order that GIVES an asset requires a proven wallet on that asset''s chain, and your key starts with only the address its account signed in with. `GET /v1/me` lists both what each chain''s `login` address is and what you have `proven`; `POST /v1/wallets/{evm|tron|solana|bitcoin}` proves another by signature — Bitcoin included, on a BIP-322 one. A proof adds trading reach and nothing else: it never becomes the account''s payout identity, which only a wallet session can change — so a key alone cannot redirect anyone''s money. The message you sign for it must say `link this wallet` and carry a nonce from `GET /v1/wallets/nonce`; that nonce is not a login nonce, so the signature you collect is not a session for that wallet''s account. **Rate limits.** Every response carries `RateLimit-Limit`, `RateLimit-Remaining` and `RateLimit-Reset` (seconds). Over the limit returns `429` with `Retry-After`. **Idempotency.** Send an `Idempotency-Key` header on any POST to make retries safe: the operation runs once and the same response is replayed (with `Idempotency-Replayed: true`). Reusing a key with a different body returns `422`. Keys are remembered for 24h — except a `504`, which is a read of ours running out of time: on the builders nothing happened, and on `/tx/broadcast` we cannot tell — so either way a retry with the same key really retries. The fund, claim and refund builders change nothing on the server, so they run on every call and nothing of theirs is remembered — retry them freely. **Custody-agnostic settlement.** The fund/claim/refund endpoints return UNSIGNED transactions; you sign with your own key/HSM and submit via `/v1/tx/broadcast`. The server never holds your keys. ---


    ## Maker feed (WebSocket)


    Polling `GET /v1/rfqs` will not win you flow. `wss:///v1/ws` — the host you selected above — streams every request-for-quote you are eligible for, and takes your quotes back over the same socket. **Handshake.** Connect, then send your key as the first frame. Nothing else is accepted until you do:


    ```json

    { "apiKey": "hk_live_..." }

    ```


    The key needs the `maker` scope (`GET /v1/me` shows what yours has). You get a snapshot, then a readiness marker:


    ```json

    { "type": "snapshot", "rfqs": [ ... ] }

    { "type": "ready" }

    ```


    The snapshot is the **public** book only, and at most **100** entries, newest first. If you need more than that, page `GET /v1/rfqs?cursor=…` after connecting. An RFQ created while the snapshot was being built may appear both in it and in the stream that follows — frames carry the rfq id, so key on it and the duplicate is a no-op. **The stream.** Two kinds, and only two:


    ```json

    { "type": "rfq", "kind": "created", "rfq": { ... } }

    { "type": "rfq", "kind": "cancelled", "rfq": { ... } }

    ```


    `cancelled` means the order left the book, not always that its owner cancelled it: when a listed token **closes** (it no longer passes the listing checks), every public order on it is sent as `cancelled` while its status is unchanged (`open` or `negotiating`); if the token **reopens**, the same orders come back as `created` with their original id and `createdAt`. Treat both as upserts keyed on the id. An RFQ also leaves the book when it **expires** or is **agreed** with another maker, and neither emits a frame. A book you maintain purely from the stream therefore drifts: it keeps orders nobody can take any more, and quoting into one is rejected. Reconcile with a fresh `snapshot` (reconnect) or check `GET /v1/rfqs/{id}` before committing to a price. **What reaches you.** Public RFQs, plus private ones addressed to an address on your account.'
servers:
- url: https://api.hashlock.markets
  description: production
security:
- ApiKey: []
tags:
- name: Me
paths:
  /v1/me:
    get:
      summary: Verify the key, list its scopes and the wallets attached to its account
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                type: object
                properties:
                  userId:
                    type: string
                  scopes:
                    type: array
                    items:
                      type: string
                  handle:
                    type:
                    - string
                    - 'null'
                    description: the account name, set in the app (Account › Profile)
                  handlePublic:
                    type: boolean
                    description: whether the other side of a deal sees the name
                  wallets:
                    type: object
                    description: 'per chain family: the login address, and the addresses proven by signature'
                    properties:
                      evm:
                        type: object
                        properties:
                          login:
                            type:
                            - string
                            - 'null'
                            description: the address this account signed in with, and where it is paid
                          proven:
                            type: array
                            items:
                              type: string
                            description: addresses proven by signature — tradeable, never a payout identity
                      tron:
                        type: object
                        properties:
                          login:
                            type:
                            - string
                            - 'null'
                            description: the address this account signed in with, and where it is paid
                          proven:
                            type: array
                            items:
                              type: string
                            description: addresses proven by signature — tradeable, never a payout identity
                      bitcoin:
                        type: object
                        properties:
                          login:
                            type:
                            - string
                            - 'null'
                            description: the address this account signed in with, and where it is paid
                          proven:
                            type: array
                            items:
                              type: string
                            description: addresses proven by signature — tradeable, never a payout identity
                      solana:
                        type: object
                        properties:
                          login:
                            type:
                            - string
                            - 'null'
                            description: the address this account signed in with, and where it is paid
                          proven:
                            type: array
                            items:
                              type: string
                            description: addresses proven by signature — tradeable, never a payout identity
        '401':
          description: invalid key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      operationId: getMe
      tags:
      - Me
components:
  schemas:
    Error:
      type: object
      properties:
        error:
          type: string
      required:
      - error
  securitySchemes:
    ApiKey:
      type: http
      scheme: bearer
      description: 'An API key (hk_live_… / hk_test_…) with read/taker/maker scopes. `read` is read-only: every write except webhooks needs `taker` or `maker` (403 otherwise), and either of those can read too. Creating RFQs and listing tokens need `taker`; quoting needs `maker`.'