Hashlock Markets Assets API

openapi: 3.2.0
info:
  title: Hashlock Markets Assets 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: Assets
paths:
  /v1/assets:
    get:
      summary: Enabled asset registry — the whole list, or a search
      description: 'Without `q`, `limit` or `offset`: every enabled asset. Any of those turns on search, where `chain` and `verified` also apply: an exact symbol first, then verified, then alphabetical, paged by `nextOffset`.'
      parameters:
      - name: q
        in: query
        description: a symbol prefix (case-insensitive) or a full contract address
        schema:
          type: string
          maxLength: 100
      - name: chain
        in: query
        schema:
          type: string
      - name: verified
        in: query
        description: '`1` or `true`: verified (curated) assets only'
        schema:
          type: string
      - name: limit
        in: query
        description: page size, 1–200 (default 50)
        schema:
          type: integer
          minimum: 1
          maximum: 200
      - name: offset
        in: query
        description: '`nextOffset` from the previous page'
        schema:
          type: integer
          minimum: 0
          maximum: 9999
      responses:
        '200':
          description: ok — `nextOffset` appears only in search mode (null on the last page)
          content:
            application/json:
              schema:
                type: object
                properties:
                  assets:
                    type: array
                    items:
                      $ref: '#/components/schemas/Asset'
                  nextOffset:
                    type:
                    - integer
                    - 'null'
        '400':
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      operationId: getAssets
      tags:
      - Assets
    post:
      summary: Ask for a token to be listed
      description: 'Runs the same checks as the launchpad listener: an on-chain check (EVM: a simulated transfer; Solana: a classic SPL mint with no mint or freeze authority — Token-2022 is not listable), security scan (Powered by GoPlus Security) and market thresholds (market cap ≥ $1M, liquidity ≥ $100k, 24h volume ≥ $250k, ≥ 500 holders, ≥ 24h old, top 10 holders ≤ 40% excluding pools). EVM chains and Solana, where Hashlock supports them. A listed token has `verified: false`. 20 requests an hour per account.'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - chain
              - address
              properties:
                chain:
                  type: string
                address:
                  type: string
                  description: the token contract (EVM) or mint (Solana, base58 as is)
      responses:
        '200':
          description: already listed, or a closed token reopened because it passes again
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                    - listed
                  asset:
                    $ref: '#/components/schemas/Asset'
                  security:
                    type: string
        '201':
          description: 'listed now (`verified: false`)'
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                    - listed
                  asset:
                    $ref: '#/components/schemas/Asset'
                  security:
                    type: string
        '202':
          description: 'not yet. ''pending'': it stays queued and is listed automatically if it passes within a week. ''closed'': a closed listed token that does not pass yet'
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                    - pending
                    - closed
                  reasons:
                    type: array
                    items:
                      type: string
                  security:
                    type: string
        '400':
          description: not a supported chain, or not a token address on it
        '422':
          description: 'final. ''rejected'' (with reasons): it failed a safety check. ''delisted'' (with error): closed for good — by the operator, or for a safety failure after listing'
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                    - rejected
                    - delisted
                  reasons:
                    type: array
                    items:
                      type: string
                  error:
                    type: string
                  security:
                    type: string
        '429':
          description: more than 20 listing requests this hour
      operationId: postAssets
      tags:
      - Assets
components:
  schemas:
    Error:
      type: object
      properties:
        error:
          type: string
      required:
      - error
    Asset:
      type: object
      properties:
        id:
          type: string
        chain:
          type: string
        symbol:
          type: string
        name:
          type:
          - string
          - 'null'
          description: full name, e.g. 'USD Coin' — display only; null for listed (unverified) tokens
        address:
          type:
          - string
          - 'null'
          description: token contract (null = native)
        decimals:
          type: integer
        enabled:
          type: boolean
        verified:
          type: boolean
          description: curated by Hashlock; false = listed automatically after checks — trade it by contract address, not by symbol
        source:
          type: string
          description: '''curated'', ''launchpad:<bankr|virtuals|clanker>'' or ''api'''
        logoAt:
          type:
          - string
          - 'null'
          format: date-time
          description: when Hashlock fetched the token's logo, found by its contract address (null = none); the image is served at /api/assets/{id}/logo?v=<this value as epoch milliseconds>, cacheable for good at that URL
        logoAnimated:
          type: boolean
          description: the logo is an animated image
  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`.'