Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

BitClout's APIs doc #20

Open
scottstirling opened this issue Apr 12, 2021 · 7 comments
Open

BitClout's APIs doc #20

scottstirling opened this issue Apr 12, 2021 · 7 comments

Comments

@scottstirling
Copy link
Owner

scottstirling commented Apr 12, 2021

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 scottstirling changed the title TODO: document BitClout's own apis BitClout's APIs doc Apr 12, 2021
@Pycomet-zz
Copy link

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

@scottstirling
Copy link
Owner Author

scottstirling commented Apr 20, 2021

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.

@Pycomet-zz
Copy link

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.

@scottstirling
Copy link
Owner Author

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

@scottstirling
Copy link
Owner Author

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

@scottstirling
Copy link
Owner Author

scottstirling commented Apr 23, 2021

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

@scottstirling
Copy link
Owner Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants