Ospree docs
API ReferenceWebsiteSocials
  • GETTING STARTED
    • Intro to Ospree
      • What is the Travel Rule?
      • Types of Travel Rule transfers
      • What is a wallet address?
      • What is an Account at Ospree?
      • What is a VASP or CASP?
    • Account
      • Understand user roles
      • Add and manage users
      • Change your password
      • Set up two-factor authentication (2FA)
      • Log in with 2FA-enabled
  • DASHBOARD
    • Overview
    • Travel Rule
      • Start a transfer
      • Search and filter transfers
      • Interoperability
      • Self-hosted wallets
    • Accounts Directory
      • Create an account
      • Edit an account
      • Create a recipient
      • Edit a recipient
      • Add a new wallet
      • VASPs
        • Search and filter
        • Request a VASP
  • OSPREE API
    • Overview
    • API integration flows
    • Authentication
    • Breaking Changes
    • Errors
    • Token Identifier
    • Webhooks
      • Webhook events
      • Webhook request
      • Webhook management
    • Travel Rule
      • Create Transfer
      • List Transfers
      • Retrieve Transfer
      • Update Transfer
      • Action Transfer
    • Accounts Directory
      • Create Account
      • List Accounts
      • Retrieve Account
      • Update Account
      • Remove account
      • Search account
      • Retrieve VASP
      • Search VASP
      • List VASPs
    • Blockchain Analytics
      • Create Address
      • List Addresses
      • Retrieve Address
      • Assign an address to account
      • Create Transaction (Beta)
      • List Transactions (Beta)
      • Retrieve Transaction (Beta)
  • Resources and Help
    • Data pre-validation
    • Sunrise Issue
Powered by GitBook
On this page
  1. OSPREE API

Overview

Last updated 19 days ago

This section serves as a comprehensive guide to facilitate the integration and usage of our API. Whether you’re integrating for the first time or enhancing an existing setup, this documentation is designed to help you get up and running quickly. Our API reference is organized into modules. A module in the Ospree API is a self-contained functional component that groups related endpoints and operations, such as Travel Rule, Blockchain Analytics, or Directory. Ospree’s API architecture is built as an adaptable “Lego system,” enabling modular integration to accommodate the specific needs of your business as it scales. Each module includes:

  1. Data Representations: Clear descriptions of the data structures associated with each resource type, helping you understand what data you can expect and how to format your requests.

  2. Methods: Detailed explanations of the methods available for each resource type, including HTTP methods (GET, POST, PUT, DELETE) and the corresponding actions they perform.


You can use our API in a sandbox environments to refine your integration before going live in production. This approach allows you to experiment, troubleshoot, and ensure everything functions as expected without affecting your live data or operations. BASE URL SANDBOX: https://sandbox.ospree.io BASE URL PRODUCTION: https://api.ospree.io If you have questions, you can contact the development team at

support@ospree.io
Cover

Travel Rule

Explore Travel Rule module endpoints here.

Travel Rule
Cover

Account Directory

Discover Account Directory API endpoints.

Accounts Directory
Cover

Blockchain Analytics

Access Blockchain Analytics module endpoints.

Blockchain Analytics