Trustless Work
  • Welcome
    • Why Escrows Matter
    • ๐Ÿ›ค๏ธOur Journey so Far
      • ๐Ÿค”The Problem: Origins of Trustless Work
      • ๐Ÿ‘พThe team comes together
      • ๐Ÿ’กThe Solution: Escrows
      • ๐Ÿ†Key Milestones
        • ๐ŸŒ DraperU Stellar Astro Hacker House: A Pivotal Moment
        • Launching the API V1 at ETH Pura Vida Hackathon
      • ๐Ÿš€Current Programs
        • ๐ŸŒŸDraperU Embark Program
        • ๐Ÿ’ปOD Hack Campaigns
      • ๐Ÿ› ๏ธVertical Development
      • ๐Ÿ”ฎFuture Vision
  • ๐Ÿ“ŒStart Here
    • โ˜€๏ธAbout Trustless Work
      • Vision and Mission
      • Team
  • โš’๏ธUnderstanding Smart Escrows
    • ๐ŸฅธSmart Escrow Design
      • What does a Smart Escrow "look like"?
      • Roles in Trustless Work
      • Escrow Lifecycle
        • Initiation Phase
        • Funding Phase
        • Complete phase
        • Approval phase
        • Release phase
        • Dispute Resolution
    • ๐Ÿ’ตUSDC: The Stablecoin Powering Trustless Work
    • ๐ŸŒŸStellar & Soroban: The Backbone of Trustless Work
  • ๐Ÿ’ปDeveloper Resources
    • ๐Ÿš€Smart Escrow API
    • Quickstart
      • Integration Demo Project
        • Getting Started
        • Entities
        • Configuration
        • Context API
        • Wallet Setup
        • Trustlines
        • Services
        • Helpers
        • Error Handling
        • Forms
          • Initialize Escrow
          • Fund Escrow
          • Get Escrow
          • Get Multiple Escrow Balances
          • Resolve Dispute
          • Change Milestone Status
          • Change Milestone Flag
          • Change Dispute Flag
          • Release Funds
          • Update Escrow
        • UI Components
          • Pages
          • Cards
          • Tabs
          • Utils
      • dApp locally
      • API Fundamental Code
    • API Reference
      • Introduction
      • Authentication
        • Request Api Key
      • Deploy
        • Initialize Escrow
      • Escrows
        • Schema
        • Fund Escrow
        • Get Escrow by Contract ID
        • Resolve Dispute
        • Change Milestone Status
        • Change Milestone Flag
        • Change Dispute Flag
        • Release Funds
        • Update escrow properties
      • Helpers
        • Set Trustline
        • Send Transaction
        • Get Multiple Escrow Balance
    • ๐ŸงฐEssential Tools for Developers
      • Stellar Wallets
        • Freighter Wallet
        • Albedo Wallet
        • xBull Wallet
        • Rabet Wallet
        • Lobstr Wallet
        • Hana Wallet
        • Additional Resources
        • Troubleshooting & FAQs
      • How to Get Testnet Tokens
  • ๐ŸŒUse Cases by Industry
    • Marketplaces & E-commerce
    • Grants, Bounties, and Hackathons
    • P2P Exchanges and OTC Desks
    • Security Deposits
    • Milestone-based Freelance & Contract Work
    • Crowdfunding & Pre-orders
    • DAO Treasury & Working Group Budgets
    • Education & Online Courses
    • Subscription + Performance-based Retainers
  • ๐Ÿค–Using the dApp
    • Step 1: Accessing the Trustless Work Dapp and Logging In
    • Step 2: Creating a Profile and Requesting an API Key
    • Step 3: Creating an Escrow
    • Step 4: Funding an Escrow
    • Step 5: Marking a Milestone as Done โœ…
    • Step 6: Approving the Milestone
    • Step 7: Releasing the Payment
    • Resolving Disputes
  • ๐Ÿดโ€โ˜ ๏ธCommunity
    • ๐ŸŒŽSpotlight: Kindfi
    • ๐Ÿ›ฃ๏ธRoadmap: The Journey Ahead
    • Contributor's Guide
    • ๐Ÿ“‚Open-Source Templates & Developer Tools
  • โœ’๏ธBackground & Theory
    • ๐Ÿ“˜Core Concepts & Escrow Glossary
    • ๐ŸŽ’Historical Context
      • ๐Ÿ“œEscrow History:
        • ๐Ÿ—ฟAncient to Colonial Era
        • ๐ŸฆBanking Era (19th - 20th Century)
        • ๐Ÿ’ปThe Digital Era and Online Escrow
      • โ›“๏ธBlockchain Era: Smart Escrows
  • Links
    • โš’๏ธTrustless Work dApp
    • ๐ŸŒTrustless Work Website
    • ๐Ÿ“ฃTelegram Chat
    • ๐Ÿ’ŽOnly Dust Profile
    • ๐Ÿ‘ฉโ€๐Ÿ’ปSwagger for API
    • ๐Ÿ“œGithub
  • ๐Ÿ“ขAppendices
    • Contact and Support
    • Notion for Startups
    • Meru
Powered by GitBook
LogoLogo

Links

  • Website
On this page
  • Base URL
  • Warning!
  • GitHub Repository
  • API Swagger
  • Introduction to the Trustless Work REST API
  • What is the API for?
  • Key API Functions:
  • Why is the API important?
  • REST API Advantages:
  • API Use Cases

Was this helpful?

Export as PDF
  1. Developer Resources
  2. API Reference

Introduction

How to get started in Trustless Work API

PreviousAPI ReferenceNextAuthentication

Last updated 1 month ago

Was this helpful?

Base URL

Production API

https://api.trustlesswork.com

Dev API

https://dev.api.trustlesswork.com

Warning!

You'll have 50 as a request rate limit per client in the API every 60 seconds.

GitHub Repository

API Swagger

Introduction to the Trustless Work REST API

The Trustless Work REST API is designed to offer decentralized escrow solutions by leveraging the power of smart contracts on the Stellar blockchain through Soroban. This API enables platforms and businesses to integrate secure, fast, and transparent escrow services, eliminating the need to rely on centralized intermediaries.

What is the API for?

The Trustless Work API is a key component for any platform that requires secure conditional payments. It allows the creation, management, and automation of escrow contracts, providing security for both payers and payees. This API can be used across various industries including e-commerce, SaaS, real estate, freelance marketplaces, and more.

Key API Functions:

  • Create and manage escrow contracts: Users can set up payment agreements with specific conditions that must be met before funds are released.

  • Real-time status updates: The API provides real-time access to escrow statuses, allowing users to verify the state of funds at any time. (Working)

Why is the API important?

This API is critical for offering businesses an efficient and secure way to manage payments without relying on third-party services. Trustless Workโ€™s decentralized nature eliminates the risks associated with centralized intermediaries, such as delays or failures. Additionally, being blockchain-based guarantees full transparency and a significant reduction in operational costs.

REST API Advantages:

  • Transparency: Every transaction is recorded on the blockchain, making it auditable and ensuring that all parties can track the flow of funds.

  • Low Costs: Built on Stellar, the API benefits from minimal transaction fees compared to traditional solutions or even other blockchain platforms.

  • Speed: Stellar's fast transaction finality ensures that payments are processed almost in real-time.

  • Cross-chain compatibility: With USDC and Circleโ€™s cross-chain transfer protocol, the API can operate across multiple blockchains, offering flexibility to businesses.

API Use Cases

  1. Freelance marketplaces: Freelance platforms can use the API to manage milestone-based payments, enhancing trust and reducing disputes between clients and freelancers.

  2. High-value e-commerce: In peer-to-peer transactions, escrow ensures that payment is only released once the product has been received and verified.

  3. SaaS providers: Platforms managing recurring payments can leverage the API to release payments upon successful service delivery.

  4. International real estate: Trustless Work helps secure funds in cross-border real estate transactions by releasing them only when all legal and contractual obligations are met.

  5. Legal services: Law firms can manage complex multi-party agreements or settlements without needing manual escrow services.

In summary, the Trustless Work REST API provides a robust, transparent, and cost-effective solution for managing escrowed funds, catering to a wide range of industries and promoting security and trust in digital transactions.

๐Ÿ’ป
Trustless WorkGitHub
Logo
Swagger UI
Logo