Backend API

General Endpoints
Index
1
GET /
Copied!
Basic endpoint to test if your BitClout node is running.
Parameters
None
Response
1
Your BitClout node is running!
Copied!
Health Check
1
GET /api/v0/health-check
Copied!
Check if your BitClout node is synced
Parameters:
None
Response:
If node is synced and received all transactions.
1
200
Copied!
Get Exchange Rate
1
GET /api/v0/get-exchange-rate
Copied!
Get BitClout exchange rate, total amount of nanos sold, and Bitcoin exchange rate.
Parameters:
None
Response:
1
{
2
    "SatoshisPerBitCloutExchangeRate":498484,
3
    "NanosSold":8491518125648433,
4
    "USDCentsPerBitcoinExchangeRate":3608200
5
}
Copied!
Get App State
1
POST /api/v0/get-app-state
Copied!
Get state of BitClout App, such as cost of profile creation and diamond level map. Example use in the frontend and endpoint implementation in backend.
Parameters
None; however, you need to send an empty JSON { }. Otherwise, you will get 400 - Bad Request. More info on the request here.
Name
Type
Description
PublicKeyBase58Check
string
(optional) check public key
Response
1
{
2
    "AmplitudeKey": "",
3
    "AmplitudeDomain": "api.amplitude.com",
4
    "MinSatoshisBurnedForProfileCreation": 50000,
5
    "IsTestnet": false,
6
    "SupportEmail": "[email protected]",
7
    "ShowProcessingSpinners": true,
8
    "HasStarterBitCloutSeed": false,
9
    "HasTwilioAPIKey": false,
10
    "CreateProfileFeeNanos": 10000000,
11
    "CompProfileCreation": false,
12
    "DiamondLevelMap": {
13
        "1": 50000,
14
        "2": 500000,
15
        "3": 5000000,
16
        "4": 50000000,
17
        "5": 500000000,
18
        "6": 5000000000,
19
        "7": 50000000000,
20
        "8": 500000000000
21
    },
22
    "HasWyreIntegration": false,
23
    "Password": ""
24
}
Copied!
Transaction Endpoints
Get Txn
1
POST /api/v0/get-txn
Copied!
Check if Txn is currently in mempool. Example use in the frontend and endpoint implementation in backend.
Parameters
More info on the request here.
Name
Type
Description
TxnHashHex
string
Transaction hash
Response
1
{
2
    "TxnFound": true
3
}
Copied!
Submit Transaction
1
POST /api/v0/submit-transaction
Copied!
Submit transaction to BitClout blockchain. Example use in frontend and endpoint implementation in backend.
Parameters
Read more on transaction format here. More info on the request here.
Name
Type
Description
TransactionHex
string
Transaction hash
Response
1
{
2
    Transaction: {
3
        TxInputs : [ 
4
            {
5
                TxID: [...],
6
                Index: 0
7
            } , ...
8
        ],
9
        TxOutputs : [
10
            {
11
                PublicKey: "...",
12
                AmountNanos: 999420
13
            }, ...
14
        ],
15
        TxnMeta : {...},
16
        PublicKey: "...",
17
        ExtraData: {...},
18
        Signature: {...},
19
        TxnTypeJSON: 6
20
    },
21
    TxnHashHex: "...",
22
    PostEntryResponse: {...}
23
}
Copied!
Update Profile
1
POST /api/v0/update-profile
Copied!
Update profile fields and receive corresponding Txn. Transaction needs to be signed and submitted through api/v0/submit-transaction before changes come into effect. Example use in frontend and endpoint implementation in backend.
Parameters
More info on the request here.
Name
Type
Description
UpdaterPublicKeyBase58Check
string
Public key of updater
ProfilePublicKeyBase58Check
string
(optional) Public key of the profile if different from updater
NewUsername
string
Username
NewDescription
string
Description
NewProfilePic
string
Profile picture
NewCreatorBasisPoints
uint64
Creator Reward
NewStakeMultipleBasisPoints
uint64
Staking Reward
IsHidden
bool
​
MinFeeRateNanosPerKB
uint64
Rate per KB
Response
1
{
2
    TotalInputNanos: 999999,
3
    ChangeAmountNanos: 999420,
4
    FeeNanos: 579
5
    Transaction: {
6
        TxInputs : [ 
7
            {
8
                TxID: [...],
9
                Index: 0
10
            } , ...
11
        ],
12
        TxOutputs : [
13
            {
14
                PublicKey: "...",
15
                AmountNanos: 999420
16
            }, ...
17
        ],
18
        TxnMeta : {...},
19
        PublicKey: "...",
20
        ExtraData: {...},
21
        Signature: {...},
22
        TxnTypeJSON: 6
23
    },
24
    TransactionHex: "...",
25
    TxnHashHex: "..."
26
}
Copied!
Burn Bitcoin
TODO
Send BitClout
1
POST /api/v0/send-bitclout
Copied!
Prepare transaction for sending BitClout. Transaction needs to be signed and submitted through api/v0/submit-transaction before changes come into effect. Example use in frontend and endpoint implementation in backend.
Parameters
More info on the request here.
Name
Type
Description
SenderPublicKeyBase58Check
string
Public key of the sender
RecipientPublicKeyOrUsername
string
Public key of the recipient
AmountNanos
int64
transaction amount in nanos
MinFeeRateNanosPerKB
uint64
Rate per KB
Response
1
{
2
    TotalInputNanos: 2220387140,
3
    SpendAmountNanos: 2000000000
4
    ChangeAmountNanos: 220386848,
5
    FeeNanos: 579
6
    Transaction: {
7
        TxInputs : [ 
8
            {
9
                TxID: [...],
10
                Index: 0
11
            } , ...
12
        ],
13
        TxOutputs : [
14
            {
15
                PublicKey: "...",
16
                AmountNanos: 999420
17
            }, ...
18
        ],
19
        TxnMeta : {...},
20
        PublicKey: "...",
21
        ExtraData: {...},
22
        Signature: {...},
23
        TxnTypeJSON: 6
24
    },
25
    TransactionHex: "...",
26
    TxnHashHex: "...",
27
}
Copied!
Submit Post
1
POST /api/v0/submit-post
Copied!
Prepare transaction for submiting a post. Transaction needs to be signed and submitted through api/v0/submit-transaction before changes come into effect. Example use in frontend and endpoint implementation in backend.
Parameters
More info on the request here.
Name
Type
Description
UpdaterPublicKeyBase58Check
string
Public key of the updater
PostHashHexToModify
string
(optional) Modified post's hash
ParentStakeID
string
(optional)
Title
string
(optional)
BodyObj
json
{Body: STRING, ImageURLs: []}
RecloutedPostHashHex
string
(optional) hash of post to modify
PostExtraData
json
(optional) extra data, values must be strings
IsHidden
bool
​
MinFeeRateNanosPerKB
uint64
Rate per KB
Response
1
{
2
    TstampNanos: 1623106441519911200,
3
    PostHashHex: "..."
4
    TotalInputNanos: 96669,
5
    ChangeAmountNanos: 96434,
6
    FeeNanos: 235,
7
    Transaction: {
8
        TxInputs : [ 
9
            {
10
                TxID: [...],
11
                Index: 0
12
            } , ...
13
        ],
14
        TxOutputs : [
15
            {
16
                PublicKey: "...",
17
                AmountNanos: 999420
18
            }, ...
19
        ],
20
        TxnMeta : {...},
21
        PublicKey: "...",
22
        ExtraData: {...},
23
        Signature: {...},
24
        TxnTypeJSON: 6
25
    },
26
    TransactionHex: "...",
27
}
Copied!
Create Follow Txn Stateless
1
POST /api/v0/create-follow-txn-stateless
Copied!
Prepare a follow/unfollow transaction. Transaction needs to be signed and submitted through api/v0/submit-transaction before changes come into effect. Example use in frontend and endpoint implementation in backend.
Parameters
More info on the request here.
Name
Type
Description
FollowerPublicKeyBase58Check
string
Public key of creator followed
FollowedPublicKeyBase58Check
string
Public key of follower
IsUnfollow
bool
false if follow / true if unfollow
MinFeeRateNanosPerKB
uint64
Rate per KB
Response
1
{
2
    TotalInputNanos: 220387362,
3
    ChangeAmountNanos: 220387140
4
    FeeNanos: 235,
5
    Transaction: {
6
        TxInputs : [ 
7
            {
8
                TxID: [...],
9
                Index: 0
10
            } , ...
11
        ],
12
        TxOutputs : [
13
            {
14
                PublicKey: "...",
15
                AmountNanos: 999420
16
            }, ...
17
        ],
18
        TxnMeta : {...},
19
        PublicKey: "...",
20
        ExtraData: {...},
21
        Signature: {...},
22
        TxnTypeJSON: 6
23
    },
24
    TransactionHex: "...",
25
}
Copied!
Creator Like Stateless
1
POST /api/v0/create-like-stateless
Copied!
Prepare a like/unlike transaction. Transaction needs to be signed and submitted through api/v0/submit-transaction before changes come into effect. Example use in frontend and implementation in backend.
Parameters
More info on the request here.
Name
Type
Description
ReaderPublicKeyBase58Check
string
Public key of reader
LikedPostHashHex
string
Hash of liked post
IsUnlike
bool
false if like / true if unlike
MinFeeRateNanosPerKB
uint64
Rate per KB
Response
1
{
2
    TotalInputNanos: 220387362,
3
    ChangeAmountNanos: 220387140
4
    FeeNanos: 235,
5
    Transaction: {
6
        TxInputs : [ 
7
            {
8
                TxID: [...],
9
                Index: 0
10
            } , ...
11
        ],
12
        TxOutputs : [
13
            {
14
                PublicKey: "...",
15
                AmountNanos: 999420
16
            }, ...
17
        ],
18
        TxnMeta : {...},
19
        PublicKey: "...",
20
        ExtraData: {...},
21
        Signature: {...},
22
        TxnTypeJSON: 6
23
    },
24
    TransactionHex: "...",
25
}
Copied!
Buy or Sell Creator Coin
1
POST /api/v0/buy-or-sell-creator-coin
Copied!
Prepare transaction for buying/selling creator coin. Transaction needs to be signed and submitted through api/v0/submit-transaction before changes come into effect. Example use in frontend and implementation in backend.
Parameters
More info on the request here.
Name
Type
Description
UpdaterPublicKeyBase58Check
string
Public key of updater
CreatorPublicKeyBase58Check
string
Public key of creator
OperationType
string
"buy" or "sell"
BitCloutToSellNanos
uint64
Amount of BitClout to spend
CreatorCoinToSellNanos
uint64
Amount of Creator Coin to spend
BitCloutToAddNanos
uint64
0
MinBitCloutExpectedNanos
uint64
0
MinCreatorCoinExpectedNanos
uint64
0
MinFeeRateNanosPerKB
uint64
Rate per KB
Response
1
{
2
    ExpectedBitCloutReturnedNanos: 0,
3
    ExpectedCreatorCoinReturnedNanos: 220387140
4
    FounderRewardGeneratedNanos: 0,
5
    FounderRewardGeneratedNanos    0
6
    SpendAmountNanos    285038185
7
    TotalInputNanos    1220385962
8
    ChangeAmountNanos    935347512,
9
    FeeNanos: 265
10
    Transaction: {
11
        TxInputs : [ 
12
            {
13
                TxID: [...],
14
                Index: 0
15
            } , ...
16
        ],
17
        TxOutputs : [
18
            {
19
                PublicKey: "...",
20
                AmountNanos: 999420
21
            }, ...
22
        ],
23
        TxnMeta : {...},
24
        PublicKey: "...",
25
        ExtraData: {...},
26
        Signature: {...},
27
        TxnTypeJSON: 6
28
    },
29
    TransactionHex: "...",
30
    TxnHashHex: "..."
31
}
Copied!
Transfer Creator Coin
1
POST /api/v0/transfer-creator-coin
Copied!
Prepare transaction for transfering creator coin. Transaction needs to be signed and submitted through api/v0/submit-transaction before changes come into effect. Example use in frontend and implementation in backend.
Parameters
More info on the request here.
Name
Type
Description
SenderPublicKeyBase58Check
string
Public key of sender
CreatorPublicKeyBase58Check
string
Public key of creator
ReceiverUsernameOrPublicKeyBase58Check
string
username or public key of receiver
CreatorCoinToTransferNanos
uint64
Amount of Creator Coin to transfer
MinFeeRateNanosPerKB
uint64
Rate per KB
Response
1
{
2
    SpendAmountNanos: 0,
3
    TotalInputNanos    355031025
4
    ChangeAmountNanos    355030764
5
    FeeNanos    261
6
    Transaction: {
7
        TxInputs : [ 
8
            {
9
                TxID: [...],
10
                Index: 0
11
            } , ...
12
        ],
13
        TxOutputs : [
14
            {
15
                PublicKey: "...",
16
                AmountNanos: 999420
17
            }, ...
18
        ],
19
        TxnMeta : {...},
20
        PublicKey: "...",
21
        ExtraData: {...},
22
        Signature: {...},
23
        TxnTypeJSON: 6
24
    },
25
    TransactionHex: "...",
26
    TxnHashHex: "..."
27
}
Copied!
Send Diamonds
1
POST /api/v0/send-diamonds
Copied!
Prepare transaction for sending diamonds 💎. Transaction needs to be signed and submitted through api/v0/submit-transaction before changes come into effect. Example use in frontend and implementation in backend.
Parameters
More info on the request here.
Name
Type
Description
SenderPublicKeyBase58Check
string
Public key of sender
ReceiverPublicKeyBase58Check
string
Public key of receiver
DiamondPostHashHex
string
Hash of post receiving diamond
DiamondLevel
int64
Diamond level
MinFeeRateNanosPerKB
uint64
Rate per KB
Response
1
{
2
    SpendAmountNanos: 0,
3
    TotalInputNanos    355031025
4
    ChangeAmountNanos    355030764
5
    FeeNanos    261
6
    Transaction: {
7
        TxInputs : [ 
8
            {
9
                TxID: [...],
10
                Index: 0
11
            } , ...
12
        ],
13
        TxOutputs : [
14
            {
15
                PublicKey: "...",
16
                AmountNanos: 999420
17
            }, ...
18
        ],
19
        TxnMeta : {...},
20
        PublicKey: "...",
21
        ExtraData: {...},
22
        Signature: {...},
23
        TxnTypeJSON: 6
24
    },
25
    TransactionHex: "...",
26
    TxnHashHex: "..."
27
}
Copied!
User Endpoints
Get Users Stateless
1
POST /api/v0/get-users-stateless
Copied!
Get information about users. Request contains a list of public keys of users to fetch. Example use in frontend and implementation in backend.
Parameters
More info on the request here.
Name
Type
Description
PublicKeysBase58Check
[]string
list of public keys
SkipHodlings
bool
HODL
Response
1
{
2
    UserList:[
3
        {
4
            PublicKeyBase58Check    "BC1YLg3FS19Syz9h6fqErZEtsKkRxBfkzqp75PiGwMUXJ1fLrytRVVk"
5
            ProfileEntryResponse    null
6
            Utxos    null
7
            BalanceNanos    0
8
            UnminedBalanceNanos    0
9
            PublicKeysBase58CheckFollowedByUser    []
10
            UsersYouHODL    null
11
            UsersWhoHODLYou    null
12
            HasPhoneNumber    false
13
            CanCreateProfile    true
14
            BlockedPubKeys    Object { }
15
            IsAdmin    true
16
            IsBlacklisted    false
17
            IsGraylisted    false
18
        }, ...
19
    ],
20
    DefaultFeeRateNanosPerKB: 100,
21
    ParamUpdaters: {...}
22
}
Copied!
Delete Identities
1
POST /api/v0/delete-identities
Copied!
Temporary route to wipe seedinfo cookies. This endpoint relies on identity api. Example use in frontend and implementation in backend.
Parameters
None
Response
None
Get Profiles
1
POST /api/v0/get-profiles
Copied!
Get user profile information. Default number of returned profiles is 20. Example use in frontend and implementation in backend.
Parameters
OrderBy possible values: {"influencer_stake", "influencer_post_stake", "newest_last_post", "newest_last_comment", "influencer_coin_price"}. More info on the request here.
Name
Type
Description
PublicKeyBase58Check
string
(optional) Check public key
Username
string
(optional) reader username
UsernamePrefix
string
(optional) username prefix
Description
string
(optional) description
OrderBy
string
Order ENUM
NumToFetch
uint32
(optional) number of profiles to fetch
ReaderPublicKeyBase58Check
string
Reader public key
ModerationType
string
(optional) empty string or "leaderboard"
FetchUsersThatHODL
bool
If single profile is requested, return a list of HODLers
AddGlobalFeedBool
bool
If set to true posts in response will contain boolean if they are in global feed
Response
1
{
2
    ProfilesFound: [
3
        {
4
            PublicKeyBase58Check: "...",
5
            Username: "...",
6
            Description: "...",
7
            ProfilePic : "...",
8
            IsHidden: false,
9
            IsReserved: false,
10
            IsVerified: false,
11
            Comments: null,
12
            Posts: null,
13
            CoinEntry: {
14
                CreatorBasisPoints: 1000,
15
                BitCloutLockedNanos: 0,
16
                NumberOfHolders: 0,
17
                CoinsInCirculationNanos: 0,
18
                CoinWatermarkNanos: 0
19
            },
20
            CoinPriceBitCloutNanos: 0,
21
            StakeMultipleBasisPoints: 12500,
22
            StakeEntryStats: {
23
                TotalStakeNanos: 0, 
24
                TotalStakeOwedNanos: 0,
25
                TotalCreatorEarningsNanos: 0,
26
                TotalFeesBurnedNanos: 0,
27
                TotalPostStakeNanos: 0
28
            }
29
            UsersThatHODL: {...}
30
        }, ...
31
    ],
32
    NextPublicKey: null
33
}
Copied!
Get Single Profile
1
POST /api/v0/get-single-profile
Copied!
Get information about single profile. Example use in frontend and implementation in backend.
Parameters
More info on the request here.
Name
Type
Description
PublicKeyBase58Check
string
(optional) Check public key
Username
string
profile username
Response
1
{
2
    ProfilesFound: [
3
        {
4
            PublicKeyBase58Check: "...",
5
            Username: "...",
6
            Description: "...",
7
            ProfilePic : "...",
8
            IsHidden: false,
9
            IsReserved: false,
10
            IsVerified: false,
11
            Comments: null,
12
            Posts: null,
13
            CoinEntry: {
14
                CreatorBasisPoints: 1000,
15
                BitCloutLockedNanos: 0,
16
                NumberOfHolders: 0,
17
                CoinsInCirculationNanos: 0,
18
                CoinWatermarkNanos: 0
19
            },
20
            CoinPriceBitCloutNanos: 0,
21
            StakeMultipleBasisPoints: 12500,
22
            StakeEntryStats: {
23
                TotalStakeNanos: 0, 
24
                TotalStakeOwedNanos: 0,
25
                TotalCreatorEarningsNanos: 0,
26
                TotalFeesBurnedNanos: 0,
27
                TotalPostStakeNanos: 0
28
            }
29
            UsersThatHODL: {...}
30
        }, ...
31
    ],
32
    NextPublicKey: null
33
}
Copied!
Get Hodlers For Public Key
1
POST /api/v0/get-hodlers-for-public-key
Copied!
Example use in frontend and implementation in backend.
Parameters
More info on the request here.
Name
Type
Description
PublicKeyBase58Check
string
(optional) check public key
Username
string
profile username
LastPublicKeyBase58Check
string
(optional) last public key check
NumToFetch
uint64
number of records to fetch
FetchHodlings
bool
if true fetch balance for hodlings
FetchAll
bool
if true fetch all
Response
1
{
2
    Hodlers: [
3
        {
4
            HODLerPublicKeyBase58Check: "...",
5
            CreatorPublicKeyBase58Check: "...",
6
            HasPurchased: false,
7
            BalanceNanos: 2500509627,
8
            NetBalanceInMempool: 0,
9
            ProfileEntryResponse: {...}
10
        }, ...
11
    ],
12
    LastPublicKeyBase58Check: "..."
13
}
Copied!
Get Diamonds for Public Key
1
POST /api/v0/get-diamonds-for-public-key
Copied!
Example use in frontend and implementation in backend.
Parameters
More info on the request here.
Name
Type
Description
PublicKeyBase58Check
string
Check public key
FetchYouDiamonded
bool
If true fetch diamonds this user gave out
Response
1
{
2
    DiamondSenderSummaryResponses: [
3
        {
4
            SenderPublicKeyBase58Check: "...",
5
            ReceiverPublicKeyBase58Check: "...",
6
            TotalDiamonds: "...",
7
            HighestDiamondLevel: "...",
8
            DiamondLevelMap: {...},
9
            ProfileEntryResponse: {...}
10
        }, ...
11
    ],
12
    TotalDiamonds: 555
13
}
Copied!
Get Follows Stateless
1
POST /api/v0/get-follows-stateless
Copied!
Get followers. Example use in frontend and endpoint implementation in backend.
Parameters
Either publickey or username can be set. More info on the request here.
Name
Type
Description
PublicKeyBase58Check
string
Check public key
Username
string
username
GetEntriesFollowingUsername
bool
Get entries following username
LastPublicKeyBase58Check
string
public key of last follower/followee
NumToFetch
uint64
number of records to fetch
Response
1
{
2
    PublicKeyToProfileEntry: {
3
        "BC1YLfuD5AGm2guj3q5wF7WGi3jTUzNhHUHc84GtVsk9kHyxbnk5V1H" : {
4
            PublicKeyBase58Check: "...",
5
            Username: "...",
6
            Description: "...",
7
            ProfilePic : "...",
8
            IsHidden: false,
9
            IsReserved: false,
10
            IsVerified: false,
11
            Comments: null,
12
            Posts: null,
13
            CoinEntry: {
14
                CreatorBasisPoints: 1000,
15
                BitCloutLockedNanos: 0,
16
                NumberOfHolders: 0,
17
                CoinsInCirculationNanos: 0,
18
                CoinWatermarkNanos: 0
19
            },
20
            CoinPriceBitCloutNanos: 0,
21
            StakeMultipleBasisPoints: 12500,
22
            StakeEntryStats: {
23
                TotalStakeNanos: 0, 
24
                TotalStakeOwedNanos: 0,
25
                TotalCreatorEarningsNanos: 0,
26
                TotalFeesBurnedNanos: 0,
27
                TotalPostStakeNanos: 0
28
            },
29
            UsersThatHODL: {...}
30
        }, ...
31
    },
32
    NumFollowers: 17707
33
}
Copied!
Get User Global Metadata
1
POST /api/v0/get-user-global-metadata
Copied!
Get user metadata such as email and phone. This endpoint relies on identity api. Example use in frontend and endpoint implementation in backend.
Parameters
More info on the request here.
Name
Type
Description
UserPublicKeyBase58Check
string
user public key
JWT
string
JSON web token authenticating user
Response
1
{
2
    Email: "...",
3
    PhoneNumber: "..."
4
}
Copied!
Update User Global Meta
1
POST /api/v0/update-user-global-metadata
Copied!
TODO
Get Notifications
1
POST /api/v0/get-notifications
Copied!
Get user notifications. This endpoint relies on identity api. Example use in frontend and endpoint implementation in backend.
Parameters
More info on the request here.
Name
Type
Description
PublicKeyBase58Check
string
user public key
FetchStartIndex
int64
Index of notification at which to start paginated lookup. Can set to -1
NumToFetch
int64
Number of notifications to fetch
Response
1
{
2
    Notifications : [
3
        {
4
            Metadata : {
5
                BlockHashHex: "...",
6
                TxnIndexInBlock: 3921,
7
                TxnType: "FOLLOW",
8
                TransactorPublicKeyBase58Check: "...",
9
                AffectedPublicKeys: [...],
10
                BasicTransferTxindexMetadata: {...},
11
                TotalInputNanos: 89585061,
12
                TotalOutputNanos: 89584839,
13
                FeeNanos: 222,
14
                UtxoOpsDump: "..."
15
            },
16
            Txn: null,
17
            Index: 50
18
        }, ...
19
    ],
20
    ProfilesByPublicKey: {
21
        "BC1YLfuD5AGm2guj3q5wF7WGi3jTUzNhHUHc84GtVsk9kHyxbnk5V1H" : {
22
            PublicKeyBase58Check: "...",
23
            Username: "...",
24
            Description: "...",
25
            ProfilePic : "...",
26
            IsHidden: false,
27
            IsReserved: false,
28
            IsVerified: false,
29
            Comments: null,
30
            Posts: null,
31
            CoinEntry: {
32
                CreatorBasisPoints: 1000,
33
                BitCloutLockedNanos: 0,
34
                NumberOfHolders: 0,
35
                CoinsInCirculationNanos: 0,
36
                CoinWatermarkNanos: 0
37
            },
38
            CoinPriceBitCloutNanos: 0,
39
            StakeMultipleBasisPoints: 12500,
40
            StakeEntryStats: {
41
                TotalStakeNanos: 0, 
42
                TotalStakeOwedNanos: 0,
43
                TotalCreatorEarningsNanos: 0,
44
                TotalFeesBurnedNanos: 0,
45
                TotalPostStakeNanos: 0
46
            },
47
            UsersThatHODL: {...}
48
        }, ...
49
    },
50
    PostsByHash: {
51
        "5782badd48b3db0ea3074fa6339e1a726265bdfbd86ed38e1e55691f2d79b296" : {
52
            PostHashHex: "...",
53
            PosterPublicKeyBase58Check: "...",
54
            ParentStakeID : "",
55
            Body: "...",
56
            ImageURLs: [],
57
            RecloutedPostEntryResponse: null,
58
            CreatorBasisPoints: 1000,
59
            StakeMultipleBasisPoints: 12500,
60
            TimestampNanos: 1623010583195063300,
61
            IsHidden: false,
62
            ConfirmationBlockHeight: 31919,
63
            InMempool: false,
64
            StakeEntry: {...},
65
            StakeEntryStats: {...},
66
            ProfileEntryResponse: {...},
67
            Comments: null,
68
            LikeCount: 1,
69
            DiamondCount: 1,
70
            PostEntryReaderState: {...},
71
            IsPinned: false,
72
            PostExtraData: {...},
73
            CommentCount: 0,
74
            RecloutCount: 0,
75
            ParentPosts: null,
76
            DiamondsFromSender: 0
77
        }
78
    }
79
}
Copied!
Block Public Key
1
POST /api/v0/block-public-key
Copied!
Block user. This endpoint relies on identity api. Example use in frontend and endpoint implementation in backend.
Parameters
More info on the request here.
Name
Type
Description
PublicKeyBase58Check
string
user public key
BlockPublicKeyBase58Check
string
blocked user public key
Unblock
bool
false if block, true if unblock
JWT
string
JSON web token authenticating user
Response
1
{
2
    BlockedPublicKeys: {
3
        "BC1YLhqEhWvNnwW9TBqXURFqwkdpUYKrMVgTHQzopF5rRBDcD1LLSUp": {...},
4
        ...
5
    }
6
}
Copied!
Post Endpoints
Get Posts Stateless
1
POST /api/v0/get-posts-stateless
Copied!
TODO
Get Single Post
1
POST /api/v0/get-single-post
Copied!
TODO
Get Posts For Public Key
1
POST /api/v0/get-posts-for-public-key
Copied!
TODO
Get Diamonded Posts
1
POST /api/v0/get-diamonded-posts
Copied!
TODO
Media Endpoints
Upload Image
1
POST /api/v0/upload-image
Copied!
TODO
Get Full TikTok URL
1
POST /api/v0/get-full-tiktok-url
Copied!
TODO
Message Endpoints
Send Message Stateless
1
POST /api/v0/send-message-stateless
Copied!
TODO
Get Messages Stateless
1
POST /api/v0/get-messages-stateless
Copied!
Mark Contact Messages Read
1
POST /api/v0/mark-contact-messages-read
Copied!
TODO
Mark All Messages Read
1
POST /api/v0/mark-all-messages-read
Copied!
TODO
Verify Endpoints
Send Phone Number Verification Text
1
POST /api/v0/send-phone-number-verification-text
Copied!
TODO
Submit Phone Number Verification Text
1
POST /api/v0/submit-phone-number-verification-code
Copied!
TODO
Wyre Endpoints
Get Wyre Wallet Order Quotation
1
POST /api/v0/get-wyre-wallet-order-quotation
Copied!
Get Wyre Wallet Order Reservation
1
POST /api/v0/get-wyre-wallet-order-reservation
Copied!
TODO
Wyre Wallet Order Subscription
1
POST /api/v0/wyre-wallet-order-subscription
Copied!
TODO
Admin Get Wyre Orders For Public Key
1
POST /api/v0/admin/get-wyre-wallet-orders-for-public-key
Copied!
TODO
Miner Endpoints
Get Block Template
1
POST /api/v0/get-block-template
Copied!
TODO
Submit Block
1
POST /api/v0/submit-block
Copied!
TODO
Admin Node Endpoints
Node Control
1
POST /api/v0/admin/node-control
Copied!
TODO
Reprocess Bitcoin Block
1
POST /api/v0/admin/reprocess-bitcoin-block
Copied!
TODO
Get Mempool Stats
1
POST /api/v0/admin/get-mempool-stats
Copied!
TODO
Evict Unmined Bitcoin Txns
1
POST /api/v0/admin/evict-unmined-bitcoin-txns
Copied!
TODO
Admin Transaction Endpoints
Get Global Params
1
POST /api/v0/admin/get-global-params
Copied!
TODO
Update Global Params
1
POST /api/v0/admin/update-global-params
Copied!
TODO
Swap Identity
1
POST /api/v0/admin/swap-identity
Copied!
TODO
Admin User Endpoints
Update User Global Metadata
1
POST /api/v0/admin/update-user-global-metadata
Copied!