bitcloutDAO icon indicating copy to clipboard operation
bitcloutDAO copied to clipboard

BitClout's APIs doc

Open scottstirling opened this issue 4 years ago • 7 comments

TODO: sort the paths below to their endpoints and POST/GET details

api.bitclout path root: GET https://api.bitclout.com/api/v1

POST https://api.bitclout.com/api/v1/block https://api.bitclout.com/api/v1/transaction-info

bitclout.com admin paths: https://api.bitclout.com/admin or https://bitclout.com/admin

(the full admin URL paths error HTTP 405 for GETs (vs any other URLs which 404) but will return 200 for OPTIONS, which indicates their presence):

/admin - GET /admin/get-all-user-global-metadata /admin/get-mempool-stats /admin/get-user-global-metadata /admin/get-username-verification-audit-logs /admin/get-verified-users /admin/grant-verification-badge /admin/node-control /admin/pin-post /admin/remove-nil-posts /admin/remove-verification-badge /admin/reprocess-bitcoin-block /admin/swap-identity /admin/update-global-feed /admin/update-user-global-metadata

bitclout.com paths:

/404 - GET /add-stake /block-public-key /broadcast-bitcoin-txn /burn-bitcoin /buy-bitclout - GET /buy-or-sell-creator-coin-WVAzTWpGOFFnMlBvWXZhTFA4NjNSZGNW /buy-or-sell-creator-coin-preview-WVAzTWpGOFFnMlBvWXZhTFA4NjNSZGNW /check-login-user-stateless /create-follow-txn-stateless /create-like-stateless /create-user-stateless - OPTIONS, POST /creators - GET /get-app-state - OPTIONS, POST /get-block-template /get-exchange-rate - GET /get-follows-stateless /get-messages-stateless - OPTIONS, POST /get-notifications /get-posts-stateless /get-profiles - OPTIONS, POST /get-single-post /get-starter-bitclout - GET /get-txn /get-user-global-metadata /get-users-stateless - OPTIONS, POST /inbox - GET /log-in - GET /logout /miner-control /notifications - GET (notifications not implemented as of date 4/13/2021) /posts/new - GET (screen with form input to author new content post) /send-bitclout - GET (screen to Send $BitClout) /send-message-stateless /send-phone-number-verification-text /settings - GET (currently email is the only updatable setting) /signature /sign-up - GET (Sign up screen) /submit-phone-number-verification-code /submit-post /terms-of-service - GET /u/${profile} - GET (Profile screen) /u/${profile}/sell - GET (Sell ${profile} coin) /u/${profile}/trade - GET (Buy ${profile} coin) /update-bitcoin-usd-exchange-rate /update-profile - GET (Update Profile screen) /update-user-global-metadata /wallet - GET (Wallet screen)

Some of the APIs require a special miner public key parameter unavailable to public users.

Work in progress ...

scottstirling avatar Apr 12 '21 17:04 scottstirling

Hi @scottstirling, this is really awesome work you have done here.

Can you help me out? Trying to access bitclout.com paths but they all return a 404 Not Found Error

Pycomet-zz avatar Apr 19 '21 03:04 Pycomet-zz

Hi @scottstirling, this is really awesome work you have done here.

Can you help me out? Trying to access bitclout.com paths but they all return a 404 Not Found Error

Thanks, @Pycomet - please give me an example and I'll try to figure it out - some of them work as GET, some require POST, and some require a special "miner" Public key which regular users do not have.

scottstirling avatar Apr 20 '21 04:04 scottstirling

I am guessing all the /admin paths require a special "miner" public key and how do I get one? Because all I get in return, empty response for all of them.

Pycomet-zz avatar Apr 21 '21 20:04 Pycomet-zz

Unless you run a node locally in which case you can now admin your own profile. See the bitclout/run project released tonight.

scottstirling avatar Apr 23 '21 09:04 scottstirling

Caution: the node is not source. It is a Docker image prebuilt with a binary executable inside.

scottstirling avatar Apr 23 '21 09:04 scottstirling

And a set of scripts and files that pull that Docker image down for you and start it up. Caveat emptor

scottstirling avatar Apr 23 '21 09:04 scottstirling

I’ll say I’ve already tried it in a sandbox env. Which led me to discover the dependencies on BadgerDB.

scottstirling avatar Apr 23 '21 09:04 scottstirling