# Generated by Scrape::ApiDefinitionsJob: 2018-09-25 01:15:43 UTC
# See: https://git.io/vx5CY
---
- name: Follow API
  description: Used to lookup information related to reputation and account follow
    operations. **These AppBase API methods are still under development and subject
    to change.**
  methods:
  - api_method: follow_api.get_account_reputations
    since: HF13
    purpose: |
      Returns a list of account reputations.
      
      Also see: [Paginated API Methods]({{ '/tutorials-recipes/paginated-api-methods.html#follow_apiget_account_reputations' | relative_url }})
    parameter_json: '{"account_lower_bound":"","limit":1000}'
    expected_response_json: |
      {
        "reputations": [
          {
            "account": "",
            "reputation": 0
          }
        ]
      }
    curl_examples:
    - '{"jsonrpc":"2.0", "method":"follow_api.get_account_reputations", "params":{"account_lower_bound":"hiveio",
      "limit":1}, "id":1}'
    - '{"jsonrpc":"2.0", "method":"follow_api.get_account_reputations", "params":{"account_lower_bound":"a",
      "limit":10}, "id":1}'
    client_docs:
      - '[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-account-reputations)'
      - '[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-account-reputations)'
      - '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)'
  - api_method: follow_api.get_blog
    purpose: |
      Returns the list of blog entries for an account.
      
      Also see: [Paginated API Methods]({{ '/tutorials-recipes/paginated-api-methods.html#follow_apiget_blog' | relative_url }})
    parameter_json: '{"account":"","start_entry_id":0,"limit":500}'
    expected_response_json: |
      {
        "blog": [
          {
            "comment": {
              "id": 6119,
              "author": "gtg",
              "permlink": "testing",
              "category": "smt",
              "parent_author": "",
              "parent_permlink": "smt",
              "title": "[SMT] Testnet",
              "body": "https://www.youtube.com/watch?v=YRwHrVVU2NA",
              "json_metadata": "",
              "last_update": "2019-12-07T13:24:48",
              "created": "2019-12-07T13:24:48",
              "active": "2019-12-07T13:29:30",
              "last_payout": "2019-12-07T14:24:48",
              "depth": 0,
              "children": 8,
              "net_rshares": 0,
              "abs_rshares": 0,
              "vote_rshares": 0,
              "children_abs_rshares": 0,
              "cashout_time": "1969-12-31T23:59:59",
              "max_cashout_time": "1969-12-31T23:59:59",
              "total_vote_weight": 0,
              "reward_weight": 10000,
              "total_payout_value": {
                "amount": "140916",
                "precision": 3,
                "nai": "@@000000013"
              },
              "curator_payout_value": {
                "amount": "140916",
                "precision": 3,
                "nai": "@@000000013"
              },
              "author_rewards": 140916,
              "net_votes": 0,
              "root_author": "gtg",
              "root_permlink": "testing",
              "max_accepted_payout": {
                "amount": "1000000000",
                "precision": 3,
                "nai": "@@000000013"
              },
              "percent_hbd": 10000,
              "allow_replies": true,
              "allow_votes": true,
              "allow_curation_rewards": true,
              "beneficiaries": []
            },
            "blog": "gtg",
            "reblog_on": "1970-01-01T00:00:00",
            "entry_id": 0
          }
        ]
      }
    curl_examples:
    - '{"jsonrpc":"2.0", "method":"follow_api.get_blog", "params":{"account":"hiveio","start_entry_id":0,"limit":1},
      "id":1}'
    - '{"jsonrpc":"2.0", "method":"follow_api.get_blog", "params":{"account":"alice","start_entry_id":0,"limit":50},
      "id":1}'
    client_docs:
      - '[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-blog)'
      - '[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-blog)'
      - '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)'
  - api_method: follow_api.get_blog_authors
    purpose: |
      Returns a list of authors that have had their content reblogged on a given blog account.
    parameter_json: '{"blog_account":""}'
    expected_response_json: |
      {
        "blog_authors": [
          {
            "author": "",
            "count": 1
          }
        ]
      }
    curl_examples:
    - '{"jsonrpc":"2.0", "method":"follow_api.get_blog_authors", "params":{"blog_account":"hiveio"},
      "id":1}'
    - '{"jsonrpc":"2.0", "method":"follow_api.get_blog_authors", "params":{"blog_account":"alice"},
      "id":1}'
    client_docs:
      - '[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-blog-authors)'
      - '[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-blog-authors)'
      - '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)'
  - api_method: follow_api.get_blog_entries
    purpose: |
      Returns a list of blog entries for an account.
      
      Also see: [Paginated API Methods]({{ '/tutorials-recipes/paginated-api-methods.html#follow_apiget_blog_entries' | relative_url }})
    parameter_json: '{"account":"","start_entry_id":0,"limit":500}'
    expected_response_json: |
      {
        "blog": [
          {
            "author": "gtg",
            "permlink": "testing",
            "blog": "gtg",
            "reblog_on": "1970-01-01T00:00:00",
            "entry_id": 0
          }
        ]
      }
    curl_examples:
    - '{"jsonrpc":"2.0", "method":"follow_api.get_blog_entries", "params":{"account":"hiveio","start_entry_id":0,"limit":1},
      "id":1}'
    - '{"jsonrpc":"2.0", "method":"follow_api.get_blog_entries", "params":{"account":"alice","start_entry_id":0,"limit":50},
      "id":1}'
    client_docs:
      - '[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-blog-entries)'
      - '[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-blog-entries)'
      - '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)'
  - api_method: follow_api.get_feed
    since: HF14
    purpose: |
      Returns a list of items in an account's feed.
      
      Also see: [Paginated API Methods]({{ '/tutorials-recipes/paginated-api-methods.html#follow_apiget_feed' | relative_url }})
    parameter_json: '{"account":"","start_entry_id":0,"limit":500}'
    expected_response_json: '{"feed":[]}' # TODO - recheck in HF23
    curl_examples:
    - '{"jsonrpc":"2.0", "method":"follow_api.get_feed", "params":{"account":"hiveio","start_entry_id":0,"limit":1},
      "id":1}'
    - '{"jsonrpc":"2.0", "method":"follow_api.get_feed", "params":{"account":"alice","start_entry_id":1,"limit":10},
      "id":1}'
    client_docs:
      - '[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-feed-entries)'
      - '[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-feed)'
      - '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)'
  - api_method: follow_api.get_feed_entries
    since: HF14
    purpose: |
      Returns a list of entries in an account's feed.
      
      Also see: [Paginated API Methods]({{ '/tutorials-recipes/paginated-api-methods.html#follow_apiget_feed_entries' | relative_url }})
    parameter_json: '{"account":"","start_entry_id":0,"limit":500}'
    expected_response_json: '{"feed":[]}' # TODO - recheck in HF23
    curl_examples:
    - '{"jsonrpc":"2.0", "method":"follow_api.get_feed_entries", "params":{"account":"hiveio","start_entry_id":0,"limit":1},
      "id":1}'
    - '{"jsonrpc":"2.0", "method":"follow_api.get_feed_entries", "params":{"account":"alice","start_entry_id":1,"limit":10},
      "id":1}'
    client_docs:
      - '[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-feed-entries)'
      - '[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-feed-entries)'
      - '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)'
  - api_method: follow_api.get_follow_count
    since: HF9
    purpose: Returns the count of followers for an account.
    parameter_json: '{"account":""}'
    expected_response_json: |
      {
        "account": "",
        "follower_count": 0,
        "following_count": 0
      }
    curl_examples:
    - '{"jsonrpc":"2.0", "method":"follow_api.get_follow_count", "params":{"account":"hiveio"},
      "id":1}'
    - '{"jsonrpc":"2.0", "method":"follow_api.get_follow_count", "params":{"account":"alice"},
      "id":1}'
    client_docs:
      - '[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-follow-count)'
      - '[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-follow-count)'
      - '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)'
  - api_method: follow_api.get_followers
    since: HF9
    purpose: |
      Returns the list of followers for an account.
      
      Also see: [Paginated API Methods]({{ '/tutorials-recipes/paginated-api-methods.html#follow_apiget_followers' | relative_url }})
    parameter_json: '{"account":"","start":"","type":"undefined","limit":1000}'
    expected_response_json: |
      {
        "followers": [
          {
            "follower": "",
            "following": "",
            "what": [
              "blog"
            ]
          }
        ]
      }
    curl_examples:
    - '{"jsonrpc":"2.0", "method":"follow_api.get_followers", "params":{"account":"hiveio","start":null,"type":"blog","limit":10},
      "id":1}'
    - '{"jsonrpc":"2.0", "method":"follow_api.get_followers", "params":{"account":"alice","start":null,"type":"ignore","limit":100},
      "id":1}'
    client_docs:
      - '[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-followers)'
      - '[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-followers)'
      - '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)'
  - api_method: follow_api.get_following
    since: HF9
    purpose: |
      Returns the list of accounts that are following an account.
      
      Also see: [Paginated API Methods]({{ '/tutorials-recipes/paginated-api-methods.html#follow_apiget_following' | relative_url }})
    parameter_json: '{"account":"","start":"","type":"undefined","limit":1000}'
    expected_response_json: |
      {
        "following": [
          {
            "follower": "",
            "following": "",
            "what": [
              "blog"
            ]
          }
        ]
      }
    curl_examples:
    - '{"jsonrpc":"2.0", "method":"follow_api.get_following", "params":{"account":"hiveio","start":null,"type":"blog","limit":10},
      "id":1}'
    - '{"jsonrpc":"2.0", "method":"follow_api.get_following", "params":{"account":"alice","start":null,"type":"ignore","limit":100},
      "id":1}'
    client_docs:
      - '[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-following)'
      - '[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-following)'
      - '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)'
  - api_method: follow_api.get_reblogged_by
    since: HF14
    purpose: Returns a list of authors that have reblogged a post.
    parameter_json: '{"author":"","permlink":""}'
    expected_response_json: '{"accounts":[]}' # TODO - recheck in HF23
    curl_examples:
    - '{"jsonrpc":"2.0", "method":"follow_api.get_reblogged_by", "params":{"author":"hiveio","permlink":"firstpost"},
      "id":1}'
    - '{"jsonrpc":"2.0", "method":"follow_api.get_reblogged_by", "params":{"author":"alice","permlink":"a-post-by-alice"},
      "id":1}'
    expected_curl_responses:
    - 
    - 'unknown key:unknown key:'
    client_docs:
      - '[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-reblogged-by)'
      - '[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-reblogged-by)'
      - '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)'
