{"id":20272355,"url":"https://github.com/steemit/devportal","last_synced_at":"2025-08-21T07:33:02.338Z","repository":{"id":48763759,"uuid":"78556222","full_name":"steemit/devportal","owner":"steemit","description":"Steem Platform Developer Documentation.","archived":false,"fork":false,"pushed_at":"2025-04-08T10:03:32.000Z","size":6938,"stargazers_count":124,"open_issues_count":62,"forks_count":76,"subscribers_count":49,"default_branch":"develop","last_synced_at":"2025-05-24T20:02:50.076Z","etag":null,"topics":["documentation","steem","steemit"],"latest_commit_sha":null,"homepage":"https://developers.steem.io","language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/steemit.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-01-10T17:19:08.000Z","updated_at":"2025-03-23T03:47:08.000Z","dependencies_parsed_at":"2023-02-08T15:00:53.405Z","dependency_job_id":null,"html_url":"https://github.com/steemit/devportal","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"purl":"pkg:github/steemit/devportal","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/steemit%2Fdevportal","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/steemit%2Fdevportal/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/steemit%2Fdevportal/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/steemit%2Fdevportal/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/steemit","download_url":"https://codeload.github.com/steemit/devportal/tar.gz/refs/heads/develop","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/steemit%2Fdevportal/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":271444479,"owners_count":24760816,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-21T02:00:08.990Z","response_time":74,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation","steem","steemit"],"created_at":"2024-11-14T12:43:04.996Z","updated_at":"2025-08-21T07:32:59.269Z","avatar_url":"https://github.com/steemit.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/steemit/devportal/master/images/steemdev.png\" alt=\"Steemit API Portal\" width=\"226\"\u003e\n  \u003cbr\u003e\n  \u003cbr\u003e\n  \n\u003c/p\u003e\n\n# Steemit API Portal\n\nSteemit is the social media platform where everyone gets paid for creating and curating content.\n\nThe following API documents provide details on how to interact with the Steem blockchain database API which can get information on accounts, content, blocks and much more!\n\nThe developer portal will also serve as a toolbox for steem clients, libraries, and language wrappers.\n\n## Develop\n\nSteemit Portal was built with [Jekyll](http://jekyllrb.com/) version 3.1.6, but should support newer versions as well.\n\nInstall the dependencies with [Bundler](http://bundler.io/):\n\n~~~bash\n$ bundle install\n~~~\n\nRun `jekyll` commands through Bundler to ensure you're using the right versions:\n\n~~~bash\n$ bundle exec jekyll serve\n~~~\n\nYou can now test locally at\n~~~bash\nhttp://localhost:4000\n~~~\n\nOptionally, when running `jekyll` commands through Bundler, append `--host x.x.x.x` with the external IP address of the server to be able to connect remotely:\n~~~bash\n$ bundle exec jekyll serve --host x.x.x.x\n~~~\n~~~bash\nhttp://x.x.x.x:4000\n~~~\n\n## Rake Tasks\n\nThis application uses `rake` (Ruby's make command) to execute maintenance tasks.  You can see the complete list of tasks by typing:\n\n```bash\n$ bundle exec rake -T\n```\n\n### Production Deploy\n\nWhen you're ready to deploy this application to production, make sure you have nothing to commit and your working tree is clean, then type:\n\n```bash\n$ bundle exec rake production:deploy\n```\n\nThe above command will deploy the current site to `gh-pages`.\n\nTo reverse a previous bad deploy, use:\n\n```bash\n$ bundle exec rake production:rollback\n```\n\n### Managing API Definitions\n\nThis application maintains a copy of API Definitions in `_data/apidefinitions` in YAML format.  The purpose of these `.yml` files is to reflect details of each method.\n\nIn order to accurately synchronize the `.yml` files, we've added a `rake` task to evaluate the current state of the actual API, as reflected by the `jsonrpc` methods.\n\nThis command will check the current state of the API Definitions, report any differences, and write a new `.yml` file if these differences exist:\n\n```bash\n$ bundle exec rake scrape:api_defs\n```\n\nTypical output:\n\n```\nDefinitions for: account_by_key_api, methods: 1\nDefinitions for: account_history_api, methods: 3\nDefinitions for: condenser_api, methods: 85\nDefinitions for: database_api, methods: 46\nDefinitions for: follow_api, methods: 10\nDefinitions for: jsonrpc, methods: 2\nDefinitions for: market_history_api, methods: 7\nDefinitions for: network_broadcast_api, methods: 3\nDefinitions for: tags_api, methods: 20\nDefinitions for: witness_api, methods: 2\nMethods added or changed: 0\n```\n\nIf you're interested in running the scrape against a different server, run the command like so:\n\n```bash\n$ TEST_NODE=\u003csome server url\u003e bundle exec rake scrape:api_defs\n```\n\nAn example pointing at the steemitdev testnet:\n\n```bash\n$ TEST_NODE=https://testnet.steemitdev.com bundle exec rake scrape:api_defs\n```\n\n### Importing\n\nTo import all new tutorials from all known tutorial repositories, which is the typical use case:\n\n```bash\nbundle exec rake scrape:tutorials\n```\n\n#### Targeted Import: [devportal-tutorials-js](https://github.com/steemit/devportal-tutorials-js/tree/master/tutorials)\n\nThis command will check for new tutorials in `devportal-tutorials-js` and import them into this project.\n\n```bash\nbundle exec rake scrape:tutorials:js\n```\n\nTo force update on a particular tutorial, use the following command:\n\n```bash\nbundle exec rake scrape:tutorials:js[1,true]\n```\n\nWhere `1` represents the numerical prefix like in `01_blog_feed` and `true` instructs the task to overwrite what's there, even if it exists.\n\nOther Targeted imports supported are `:py` and `:js` using the same syntax.\n\n#### Targeted Import: [devportal-tutorials-py](https://github.com/steemit/devportal-tutorials-py/tree/master/tutorials)\n\n```bash\nbundle exec rake scrape:tutorials:py\n```\n\n#### Targeted Import: [devportal-tutorials-rb](https://github.com/steemit/devportal-tutorials-rb/tree/master/tutorials)\n\n```bash\nbundle exec rake scrape:tutorials:rb\n```\n\n### Tests\n\nTo test all `curl` examples, use the following `rake` task:\n\n```bash\n$ bundle exec rake test:curl\n```\n\nOr, to test specific API namespaces, use:\n\n```bash\n$ bundle exec rake test:curl[\"follow_api witness_api\"]\n```\n\nIf you're interested in running this test against a different server, run the command like so\n\n```bash\n$ TEST_NODE=\u003csome server url\u003e bundle exec rake test:curl\n```\n\nAn example pointing at the steemitdev testnet\n\n```bash\n$ TEST_NODE=https://testnet.steemitdev.com bundle exec rake test:curl\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsteemit%2Fdevportal","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsteemit%2Fdevportal","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsteemit%2Fdevportal/lists"}