Hive Civilization

Hive Civilization Tradefinance API

The tradefinance API from Hive Civilization — 12 operation(s) for tradefinance.

GitHub OpenAPI

Operations 12

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /v1/tradefinance/template/list List trade finance contract templates · List Tradefinance #
Ask an LLM
“Which trade finance contract templates are available to list?”
“Can I filter the template list by passing metadata?”
Tell an agent
List the trade finance templates.
List trade finance templates matching metadata {metadata}.
GET /v1/tradefinance/agents List the trade finance agents · Get Agents #
Ask an LLM
“Which agents take part in a trade finance contract?”
“What roles do the trade finance agents play?”
Tell an agent
List the trade finance agents.
Show me the agents behind trade finance.
GET /v1/tradefinance/template Get the trade finance contract template · Get Template #
Ask an LLM
“What fields does a trade finance contract need?”
“Can I see the default trade finance template before drafting a contract?”
Tell an agent
Get the trade finance contract template.
Show me the blank trade finance template.
POST /v1/tradefinance/contract Create a trade finance contract · Post Contract #
Ask an LLM
“How do I set up a trade finance contract between an importer and an exporter?”
“Can a contract specify Incoterms, ports, HS code and pickup and delivery windows?”
Tell an agent
Create a trade contract from importer {importer_did} to exporter {exporter_did} for HS code {hs_code}.
Draft a {incoterm} contract shipping from {origin_port} to {destination_port} worth {contract_value_usd} USD.
GET /v1/tradefinance/contract/{contract_id} Get a trade finance contract · Get Contract Detail #
Ask an LLM
“What are the terms and parties of a trade contract I already created?”
“Can I look up a trade finance contract by its ID?”
Tell an agent
Show me trade contract {contract_id}.
Get the details of contract {contract_id}.
POST /v1/tradefinance/fund Fund a trade finance contract · Post Fund #
Ask an LLM
“How do I put money into escrow for a trade contract?”
“Who can fund a trade finance contract?”
Tell an agent
Fund contract {contract_id} as {funder_did}.
Have {funder_did} fund the escrow for contract {contract_id}.
POST /v1/tradefinance/milestone-tick Mark a shipment milestone on a contract · Post Milestone #
Ask an LLM
“How do I record that a shipment reached a milestone on a trade contract?”
“Can I attach evidence when ticking a contract milestone by hand?”
Tell an agent
Mark milestone {milestone} on contract {contract_id}.
Tick {milestone} for contract {contract_id} with evidence {evidence}.
GET /v1/tradefinance/escrow/{contract_id} Check a contract's escrow · Get Escrow Detail #
Ask an LLM
“How much is held in escrow for my trade contract, and has it settled?”
“What's the escrow state of a trade finance contract?”
Tell an agent
Show me the escrow for contract {contract_id}.
Check escrow status on contract {contract_id}.
POST /v1/tradefinance/dispute File a dispute on a trade contract · Post Dispute #
Ask an LLM
“How do I raise a dispute when a shipment goes wrong?”
“Can I submit evidence along with a trade finance dispute?”
Tell an agent
File a dispute on contract {contract_id} for {dispute_condition} as {filer_did}.
Dispute contract {contract_id} over {dispute_condition}, filed by {filer_did}, with evidence {evidence}.
POST /v1/tradefinance/webhook Send a shipment tracking event · Post Webhook #
Ask an LLM
“Can my freight tracking system push shipment events into trade finance?”
“What happens when a DELIVERED milestone or an exception event arrives by webhook?”
Tell an agent
Send this tracking event to the trade finance webhook.
Post a shipment exception event to the tracking webhook.
GET /v1/tradefinance/dispute/{dispute_id} Get a trade finance dispute · Get Dispute Detail #
Ask an LLM
“What's the outcome of a trade dispute I filed?”
“Can I look up a trade finance dispute by its ID?”
Tell an agent
Show me dispute {dispute_id}.
Get the status of trade dispute {dispute_id}.
GET /v1/tradefinance/economics View trade finance economics · Economics #
Ask an LLM
“What are the fees and economics of the trade finance service?”
“How does trade finance make money per contract?”
Tell an agent
Show me the trade finance economics.
Get the trade finance fee breakdown.

Documentation

📖
Documentation
https://thehiveryiq.com/developers
📖
APIReference
https://receipts.thehiveryiq.com/docs
📖
GettingStarted
https://thehiveryiq.com/agents
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/thehiveryiq-com/refs/heads/main/authentication/thehiveryiq-com-authentication.yml
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/thehiveryiq-com/refs/heads/main/rate-limits/thehiveryiq-com-rate-limits.yml
📖
Documentation
https://thehiveryiq.com/sdk-quickstart/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/thehiveryiq-com/refs/heads/main/openapi/thehiveryiq-com-tradefinance-api-openapi.yml

Other Resources

🔗
LLMsTxt
https://raw.githubusercontent.com/api-evangelist/thehiveryiq-com/refs/heads/main/llms/thehiveryiq-com-receipts-llms.txt
🔗
LLMsTxt
https://receipts.thehiveryiq.com/llms.txt
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/thehiveryiq-com/refs/heads/main/data-model/thehiveryiq-com-data-model.yml
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/thehiveryiq-com/refs/heads/main/asyncapi/thehiveryiq-com-webhooks.yml
🔗
StatusPage
https://receipts.thehiveryiq.com/status
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/thehiveryiq-com/refs/heads/main/conventions/thehiveryiq-com-conventions.yml
🔗
Idempotency
https://raw.githubusercontent.com/api-evangelist/thehiveryiq-com/refs/heads/main/conventions/thehiveryiq-com-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/thehiveryiq-com/refs/heads/main/errors/thehiveryiq-com-problem-types.yml
🔗
Sandbox
https://raw.githubusercontent.com/api-evangelist/thehiveryiq-com/refs/heads/main/sandbox/thehiveryiq-com-sandbox.yml
🔗
LLMsTxt
https://raw.githubusercontent.com/api-evangelist/thehiveryiq-com/refs/heads/main/llms/thehiveryiq-com-hivecompute-llms.txt
🔗
LLMsTxt
https://api.thehiveryiq.com/llms.txt
🔗
ToolCrosswalk
https://raw.githubusercontent.com/api-evangelist/thehiveryiq-com/refs/heads/main/mcp/thehiveryiq-com-tool-crosswalk.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/thehiveryiq-com:thehiveryiq-com-tradefinance-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

thehiveryiq-com-tradefinance-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: HiveMorph v0.1 Tradefinance API
  description: 'Polymorphic agent runtime — single shape (Merchant), single supermodel (W2 MERCHANT). Three gates: NEED + YIELD + CLEAN-MONEY.'
  version: 0.1.0
tags:
- name: tradefinance
paths:
  /v1/tradefinance/template/list:
    post:
      tags:
      - tradefinance
      summary: List Tradefinance
      operationId: list_tradefinance_v1_tradefinance_template_list_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListBody'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response List Tradefinance V1 Tradefinance Template List Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/tradefinance/agents:
    get:
      tags:
      - tradefinance
      summary: Get Agents
      operationId: get_agents_v1_tradefinance_agents_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response Get Agents V1 Tradefinance Agents Get
  /v1/tradefinance/template:
    get:
      tags:
      - tradefinance
      summary: Get Template
      operationId: get_template_v1_tradefinance_template_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response Get Template V1 Tradefinance Template Get
  /v1/tradefinance/contract:
    post:
      tags:
      - tradefinance
      summary: Post Contract
      operationId: post_contract_v1_tradefinance_contract_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/hivemorph__hive_tradefinance__routes__ContractBody'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response Post Contract V1 Tradefinance Contract Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/tradefinance/contract/{contract_id}:
    get:
      tags:
      - tradefinance
      summary: Get Contract Detail
      operationId: get_contract_detail_v1_tradefinance_contract__contract_id__get
      parameters:
      - name: contract_id
        in: path
        required: true
        schema:
          type: string
          title: Contract Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Get Contract Detail V1 Tradefinance Contract  Contract Id  Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/tradefinance/fund:
    post:
      tags:
      - tradefinance
      summary: Post Fund
      operationId: post_fund_v1_tradefinance_fund_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FundBody'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response Post Fund V1 Tradefinance Fund Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/tradefinance/milestone-tick:
    post:
      tags:
      - tradefinance
      summary: Post Milestone
      operationId: post_milestone_v1_tradefinance_milestone_tick_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MilestoneBody'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response Post Milestone V1 Tradefinance Milestone Tick Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/tradefinance/escrow/{contract_id}:
    get:
      tags:
      - tradefinance
      summary: Get Escrow Detail
      operationId: get_escrow_detail_v1_tradefinance_escrow__contract_id__get
      parameters:
      - name: contract_id
        in: path
        required: true
        schema:
          type: string
          title: Contract Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Get Escrow Detail V1 Tradefinance Escrow  Contract Id  Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/tradefinance/dispute:
    post:
      tags:
      - tradefinance
      summary: Post Dispute
      operationId: post_dispute_v1_tradefinance_dispute_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/hivemorph__hive_tradefinance__routes__DisputeBody'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response Post Dispute V1 Tradefinance Dispute Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/tradefinance/webhook:
    post:
      tags:
      - tradefinance
      summary: Post Webhook
      description: 'Public tracking-event webhook. Accepts the canonical event shape

        (suitable for posting from webhook.site, Zapier, n8n, in-house ERP,

        or a freight forwarder TMS). FreightWaves SONAR / MarineTraffic AIS /

        GS1 EPCIS-shaped payloads are accepted as schema-compatible test

        targets — they are NOT integration partners.


        Routes:

        MILESTONE event → fire milestone on the escrow (and auto-settle if

        milestone == DELIVERED)

        EXCEPTION event → file dispute and resolve inline'
      operationId: post_webhook_v1_tradefinance_webhook_post
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: true
              type: object
              title: Payload
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response Post Webhook V1 Tradefinance Webhook Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/tradefinance/dispute/{dispute_id}:
    get:
      tags:
      - tradefinance
      summary: Get Dispute Detail
      operationId: get_dispute_detail_v1_tradefinance_dispute__dispute_id__get
      parameters:
      - name: dispute_id
        in: path
        required: true
        schema:
          type: string
          title: Dispute Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Get Dispute Detail V1 Tradefinance Dispute  Dispute Id  Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/tradefinance/economics:
    get:
      tags:
      - tradefinance
      summary: Economics
      operationId: economics_v1_tradefinance_economics_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response Economics V1 Tradefinance Economics Get
components:
  schemas:
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    MilestoneBody:
      properties:
        contract_id:
          type: string
          title: Contract Id
        milestone:
          type: string
          title: Milestone
        fired_by_did:
          type: string
          title: Fired By Did
          default: ''
        evidence:
          additionalProperties: true
          type: object
          title: Evidence
      type: object
      required:
      - contract_id
      - milestone
      title: MilestoneBody
    hivemorph__hive_tradefinance__routes__DisputeBody:
      properties:
        dispute_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Dispute Id
        contract_id:
          type: string
          title: Contract Id
        dispute_condition:
          type: string
          title: Dispute Condition
        filer_did:
          type: string
          title: Filer Did
        evidence:
          additionalProperties: true
          type: object
          title: Evidence
      type: object
      required:
      - contract_id
      - dispute_condition
      - filer_did
      title: DisputeBody
    hivemorph__hive_tradefinance__routes__ContractBody:
      properties:
        importer_did:
          type: string
          title: Importer Did
        exporter_did:
          type: string
          title: Exporter Did
        freight_forwarder_did:
          type: string
          title: Freight Forwarder Did
        bank_guarantor_did:
          anyOf:
          - type: string
          - type: 'null'
          title: Bank Guarantor Did
          default: ''
        origin_country:
          type: string
          maxLength: 2
          minLength: 2
          title: Origin Country
        destination_country:
          type: string
          maxLength: 2
          minLength: 2
          title: Destination Country
        incoterm:
          type: string
          title: Incoterm
        origin_port:
          type: string
          title: Origin Port
        destination_port:
          type: string
          title: Destination Port
        hs_code:
          type: string
          title: Hs Code
        goods_description:
          type: string
          title: Goods Description
        quantity:
          type: number
          exclusiveMinimum: 0.0
          title: Quantity
        unit:
          type: string
          title: Unit
        unit_value_usd:
          type: number
          minimum: 0.0
          title: Unit Value Usd
        total_value_usd:
          type: number
          exclusiveMinimum: 0.0
          title: Total Value Usd
        contract_value_usd:
          type: number
          exclusiveMinimum: 0.0
          title: Contract Value Usd
        settle_currency:
          type: string
          title: Settle Currency
          default: USDC
        settle_chain:
          type: string
          title: Settle Chain
          default: base
        payment_schedule:
          anyOf:
          - additionalProperties:
              type: number
            type: object
          - type: 'null'
          title: Payment Schedule
        pickup_window_start:
          type: number
          title: Pickup Window Start
        pickup_window_end:
          type: number
          title: Pickup Window End
        delivery_window_start:
          type: number
          title: Delivery Window Start
        delivery_window_end:
          type: number
          title: Delivery Window End
        bond_amount_usdc:
          type: number
          minimum: 0.0
          title: Bond Amount Usdc
          default: 0.0
        metadata:
          additionalProperties: true
          type: object
          title: Metadata
      type: object
      required:
      - importer_did
      - exporter_did
      - freight_forwarder_did
      - origin_country
      - destination_country
      - incoterm
      - origin_port
      - destination_port
      - hs_code
      - goods_description
      - quantity
      - unit
      - unit_value_usd
      - total_value_usd
      - contract_value_usd
      - pickup_window_start
      - pickup_window_end
      - delivery_window_start
      - delivery_window_end
      title: ContractBody
    FundBody:
      properties:
        contract_id:
          type: string
          title: Contract Id
        funder_did:
          type: string
          title: Funder Did
      type: object
      required:
      - contract_id
      - funder_did
      title: FundBody
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ListBody:
      properties:
        metadata:
          additionalProperties: true
          type: object
          title: Metadata
      type: object
      title: ListBody
x-provenance:
  method: harvested
  publisher: Hive Civilization
  source: https://receipts.thehiveryiq.com/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)