# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand. overlay: 1.0.0 info: title: API Evangelist conversational phrasing for Thehiveryiq Com Basis Perp API version: 1.0.0 extends: openapi/thehiveryiq-com-basis-perp-api-openapi.yml actions: - target: $.info update: x-apievangelist-phrasing: method: generated generated: '2026-09-26' generator: build-phrasing.py label: Generated by API Evangelist operations: 12 - target: $.paths['/v1/perp/basis/open'].post update: x-apievangelist-phrasing: intent: Open a basis perpetual position effect: write questions: - How do I open a long or short basis perp position with USDC collateral? - Can I post USDT instead of USDC as collateral on a new perp position? - What collateral is used if I don't specify an amount when opening a position? instructions: - text: Open a {side} basis perp of {size_usdc} USDC backed by {collateral_asset}. slots: side: requestBody.side size_usdc: requestBody.size_usdc collateral_asset: requestBody.collateral_asset - text: Open a new {side} perp position sized {size_usdc} USDC with {collateral_amount} {collateral_asset} collateral for owner {owner_did}. slots: side: requestBody.side size_usdc: requestBody.size_usdc collateral_amount: requestBody.collateral_amount collateral_asset: requestBody.collateral_asset owner_did: requestBody.owner_did method: generated generated: '2026-09-26' - target: $.paths['/v1/perp/basis/close'].post update: x-apievangelist-phrasing: intent: Close a basis perpetual position effect: destructive questions: - How do I fully close my basis perp position? - Can I exit an open perp position entirely in one call? instructions: - text: Close basis perp position {position_id}. slots: position_id: requestBody.position_id - text: Fully exit my perp position {position_id}. slots: position_id: requestBody.position_id method: generated generated: '2026-09-26' - target: $.paths['/v1/perp/basis/increase'].post update: x-apievangelist-phrasing: intent: Add size and collateral to a perp position effect: write questions: - How do I scale up an existing basis perp position? - Do I have to add collateral when I increase a position's size? instructions: - text: Increase position {position_id} by {additional_size_usdc} USDC with {additional_collateral} more collateral. slots: position_id: requestBody.position_id additional_size_usdc: requestBody.additional_size_usdc additional_collateral: requestBody.additional_collateral - text: Add {additional_size_usdc} USDC of size to perp {position_id}, topping up collateral by {additional_collateral}. slots: additional_size_usdc: requestBody.additional_size_usdc position_id: requestBody.position_id additional_collateral: requestBody.additional_collateral method: generated generated: '2026-09-26' - target: $.paths['/v1/perp/basis/decrease'].post update: x-apievangelist-phrasing: intent: Reduce the size of a perp position effect: write questions: - Can I partially reduce a basis perp position without closing it? - How do I trim my perp exposure by a set USDC amount? instructions: - text: Reduce position {position_id} by {reduce_size_usdc} USDC. slots: position_id: requestBody.position_id reduce_size_usdc: requestBody.reduce_size_usdc - text: Trim {reduce_size_usdc} USDC off perp {position_id} but keep it open. slots: reduce_size_usdc: requestBody.reduce_size_usdc position_id: requestBody.position_id method: generated generated: '2026-09-26' - target: $.paths['/v1/perp/basis/liquidate'].post update: x-apievangelist-phrasing: intent: Liquidate a basis perp position effect: destructive questions: - How does an admin force-liquidate an undercollateralized perp position? - What credentials are needed to liquidate a basis position? instructions: - text: Liquidate basis position {position_id}. slots: position_id: requestBody.position_id - text: Force-liquidate perp {position_id} using admin key {X-Admin-Api-Key}. slots: position_id: requestBody.position_id X-Admin-Api-Key: header.X-Admin-Api-Key method: generated generated: '2026-09-26' - target: $.paths['/v1/perp/basis/funding/tick'].post update: x-apievangelist-phrasing: intent: Apply a funding-rate tick to basis perps effect: write questions: - How is the periodic funding payment applied to open basis positions? - Can an operator trigger a funding tick manually? instructions: - text: Run a funding tick on the basis perp market. - text: Apply funding to all basis positions with admin key {X-Admin-Api-Key}. slots: X-Admin-Api-Key: header.X-Admin-Api-Key method: generated generated: '2026-09-26' - target: $.paths['/v1/perp/basis/positions'].get update: x-apievangelist-phrasing: intent: List basis perp positions effect: read questions: - Which basis perp positions do I currently hold? - Can I filter perp positions by owner or by open versus closed status? instructions: - text: List basis positions owned by {owner_did}. slots: owner_did: query.owner_did - text: Show all perp positions with status {status}. slots: status: query.status method: generated generated: '2026-09-26' - target: $.paths['/v1/perp/basis/position/{position_id}'].get update: x-apievangelist-phrasing: intent: Get one basis perp position effect: read questions: - What are the size, collateral and PnL of one specific perp position? - How do I look up a single basis position by its ID? instructions: - text: Get the details of basis position {position_id}. slots: position_id: path.position_id - text: Show me perp position {position_id}. slots: position_id: path.position_id method: generated generated: '2026-09-26' - target: $.paths['/v1/perp/basis/market'].get update: x-apievangelist-phrasing: intent: View the basis perp market state effect: read questions: - What does the basis perp market look like right now? - Where can I see the current mark and funding state of the basis market? instructions: - text: Show the current basis perp market state. - text: Pull the latest snapshot of the basis market. method: generated generated: '2026-09-26' - target: $.paths['/v1/perp/basis/leaderboard'].get update: x-apievangelist-phrasing: intent: Show the basis perp trader leaderboard effect: read questions: - Who are the top traders on the basis perp market? - Can I limit the leaderboard to the top few positions? instructions: - text: Show the top {top_n} on the basis perp leaderboard. slots: top_n: query.top_n - text: Pull the basis perp leaderboard. method: generated generated: '2026-09-26' - target: $.paths['/v1/perp/basis/gates'].get update: x-apievangelist-phrasing: intent: Check the basis perp trading gates effect: read questions: - Which gates control whether the basis perp market is open for trading? - Are any trading gates currently blocking basis perps? instructions: - text: Show the status of the basis perp gates. - text: Check which basis market gates are open or closed. method: generated generated: '2026-09-26' - target: $.paths['/v1/perp/basis/health'].get update: x-apievangelist-phrasing: intent: Check basis perp service health effect: read questions: - Is the basis perp service up? - How can I health-check the basis perpetuals endpoint? instructions: - text: Check the health of the basis perp service. - text: Ping the basis perpetuals health endpoint. method: generated generated: '2026-09-26'