List Transfer (beta)

GET /v1/transfers/list
Authorization

List transfers using available filters and pagination. All transfers are returned in created_at descending order.

HTTP Request

GET /v1/transfers/list

Query String Example 

/v1/transfers/list?user_id=user_26l6ha8syVN8oqmaHaFShTxZ5RC&source=wallet_2CxAACd2h0dwzSlsqqyFLsJXCxW

Returns

A successful response returns a list of transfer objects that had been executed (failed and successful). All unconfirmed and expired transfers will be considered abandoned and will not be returned in the result.

Query parameters

  • user_id string

    User ID to filter the transfers by.

  • source string

    Unique wallet ID transfers originate from.

  • limit string

    Number of objects to return per response, must be between 10 to 100, defaults to 50.

  • offset string

    Number of objects to offset as part of pagination.

Responses

GET /v1/transfers/list 
curl \
 -X GET https://api.streambird.io/v1/transfers/list \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "transfers": {
    "id": "transfer_2DJGkXA70OXnUF2lNvcWKDnNswt",
    "app_id": "app_25ldv51seNohTaYRsxdfoxMlAa2",
    "user_id": "user_26l6ha8syVN8oqmaHaFShTxZ5RC",
    "status": "completed",
    "source": "wallet_2CxAACd2h0dwzSlsqqyFLsJXCxW",
    "source_amount": "0.005",
    "dest": "3eiTLfEg8koaNgNMcmygm2nQ3APNNNWAyHGiooGwAziK",
    "dest_amount": "0.004995",
    "dest_currency": "SOL",
    "source_currency": "SOL",
    "custom_id": null,
    "total_fees": "0.000005",
    "notes": "test",
    "blockchain_tx_hash": "3LydQp2y2UGZ88dWwMPxs1j9PDthU3XHe5fRhqosZgAco2aw3uFKKpmKSPhQtqZoR95exqCyGeHrKXFDDEvuZCpt",
    "completed_at": 0,
    "cancelled_at": 0,
    "expires_at": 1660410036,
    "created_at": 1660409916,
    "updated_at": 1660409925
  },
  "count": 27,
  "offset": 0,
  "limit": 1
}