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
  2. Blockchain Analytics

Create Address

POST /api/v2/analytics/chains/{chain}/addresses/{address} This endpoint provides multiple functionalities for managing wallet addresses:

  • Enable wallet address screening using alternative blockchain analytics providers. In this case, scan_for_risk must be set to "true", and provider_name is required. Note: The available blockchain analytics provider may vary depending on your plan and activation settings.

  • Load a wallet address into the system without screening by setting scan_for_risk to "false".

  • Associate a wallet address with an existing account by specifying the account_ref_id.

  • Label a wallet address as a self-hosted wallet by setting is_self_hosted to "true". To use this endpoint, you must provide the wallet address hash and the blockchain network.

bitcoin, ethereum, litecoin, bitcoin-cash, doge, solana, xdc, ripple, stellar, algorand, polygon, polkadot, tezos, near.

Path Parameters

Name
Type
Description
Required

chain

string

Blockchain network name. Example: bitcoin

True

address

string

Unique blockchain identifier. Example: 1JjYpRXfPntVEJqAjxsYmvFjjJBdJyaJ2k

True

Request Body

Name
Type
Description
Required

provider_name

string

Name of the blockchain risk provider to use for screening. Examples: RDBIG (Blockchain Intelligence Group), RDCFI (Lukka, Inc.)

False

is_self_hosted

boolean

Indicates if the wallet address is self-hosted. Defaults to "false".

False

scan_for_risk

boolean

Whether to initiate a risk scan for the provided address. Defaults to "false".

False

account_ref_id

string

Reference ID of the account to associate with this wallet address.

False

Sample Requests

curl -X POST https://sandbox.ospree.io/api/v2/analytics/chains/bitcoin/addresses/1Edue8XZCWNoDBNZgnQkCCivDyr9GEo4x6

-h 'Content-Type: application/json' \
-h 'Accept: application/json' \
-h 'Authorization: ••••••' \
-d '{
	"provider_name": "RDBIG",
	"is_self_hosted": false,
	"scan_for_risk": true,
	"account_ref_id": "kxfIhp8ud8"
}'
{
    "status": "success",
    "data": {
        "address": "1Edue8XZCWNoDBNZgnQkCCivDyr9GEo4x6",
        "chain": "bitcoin",
        "symbol": "BTC",
        "is_self_hosted": true,
        "financial_data": {
            "balance": 0.0,
            "balance_usd": 0.0
        },
        "risk_data": [
            {
                "provider_name": "RDBIG",
                "risk_ratio": 100,
                "risk_descriptors": [
                    "Sanctioned OFAC"
                ],
                "vasp_name_legal": "",
                "vasp_name_business": "Binance,Suex.io,nexo,cryptox,",
                "vasp_website": null,
                "vasp_category": "exchange,exchange,exchange,exchange,",
                "created": "2025-04-15T17:30:38.019344"
            }
        ],
        "created": "2025-04-15T17:30:38.019344"
    },
    "message": null
}
curl -X POST https://sandbox.ospree.io/api/v2/analytics/chains/bitcoin/addresses/1Edue8XZCWNoDBNZgnQkCCivDyr9GEo4x6

-h 'Content-Type: application/json' \
-h 'Accept: application/json' \
-h 'Authorization: ••••••' \
-d '{
    "is_self_hosted": true,
    "scan_for_risk": false,
    "account_ref_id": "kxfIhp8ud8"
}' 
{
    "status": "success",
    "data": {
        "address": "1Edue8XZCWNoDBNZgnQkCCivDyr9GEo4x6",
        "chain": "bitcoin",
        "symbol": "BTC",
        "is_self_hosted": true,
        "financial_data": {
            "balance": 0.0,
            "balance_usd": 0.0
        },
        "risk_data": null,
        "created": "2025-04-15T17:30:38.097294+00:00"
    },
    "message": null
}

Last updated 1 month ago