Skip to content

cyberkaidev/wallet-you-api

Repository files navigation

Wallet You API

A RESTful API for Wallet you and Bank you

Links

Requirements

Setup

Create an .env file with the properties: Create an account to have your key

TATUM_SDK_V4=YOUR-API-KEY
  1. Install dependencies
yarn install
  1. Run api
yarn dev

Bitcoin API

Returns your Bitcoin balance

  GET /v1/bitcoin/get-balance/YOUR-PUBLIC-KEY
  GET /v1/bitcoin/mock/get-balance
Param Description
YOUR-PUBLIC-KEY* Public key (bitcoin)
  • Response (200)
{
  balance: string;
}

Returns your Bitcoin transactions

  GET /v1/bitcoin/get-transactions/YOUR-PUBLIC-KEY
  GET /v1/bitcoin/mock/get-transactions
Param Description
YOUR-PUBLIC-KEY* Public key (bitcoin)
  • Response (200)
{
  transactions: {
    chain: string;
    blockNumber: number | null;
    timestamp: number;
    transactionType: "incoming" | "outgoing";
    hash: string;
    address: string;
    amount: string;
  }[]
}

Stablecoin API

Returns your stablecoin balance (USDC/USDT)

  GET /v1/stablecoin/get-balance/YOUR-PUBLIC-KEY
  GET /v1/stablecoin/mock/get-balance
Param Description
YOUR-PUBLIC-KEY* Public key (ethereum)
  • Response (200)
{
  balance: {
    usdc: string;
    usdt: string;
  }
}

Returns your stablecoin transactions (USDC/USDT)

  GET /v1/stablecoin/get-transactions/YOUR-PUBLIC-KEY
  GET /v1/stablecoin/mock/get-transactions
Param Description
YOUR-PUBLIC-KEY* Public key (ethereum)
  • Response (200)
{
  transactions: {
    date: string;
    items: {
      tokenId?: string;
      amount: string;
      transactionSubtype: "incoming" | "outgoing";
      tokenName: "USDC" | "USDT";
      timestamp: number;
      hours: string;
      date: string;
    }[]
  }[]
}

About

A RESTful API for Wallet you and Bank you

Resources

Stars

Watchers

Forks

Packages

No packages published