스팀 앱 개발기 #59 - 태그별 포스트 리스트를 구하기 위한 bridge.get_ranked_posts API

dorian-mobileapp (65)in kr-dev 커뮤니티 • 3 years ago (edited)

시작하며...

태그 화면을 구현하기 위한 기나긴 여정이 진행 중입니다. 오늘은 bridge.get_ranked_posts API에 대한 내용을 정리합니다.

API URL

https://api.steemit.com
또는 다른 RPC 노드 URL
- https://api.steemzzang.com
- https://api.justyy.com
- 그 외 다수

서버에 보낼 파라메터

bridge.get_ranked_posts API를 실행할 때, 서버에 보낼 JSON 데이터는 아래와 같습니다.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "bridge.get_ranked_posts",
  "params": {
    "sort": "...",
    "tag": "...",
    "observer": "....",
    "limit": 0,
    "start_author": "...",
    "start_permlink": "..."
  }
}

필수 파라메터

sorted: 포스트 정렬 기준을 의미하며, 다음 중 하나 선택 가능합니다.
- trending
- hot
- created
- promoted
- payout
- payout_comments
- muted
tag: 검색할 포스트의 태그를 지정하세요. (예: "kr")
observer: 로그인한 계정 또는 빈 값을 지정하세요.

옵션 파라메터

limit: 검색할 포스트의 최대 개수를 지정하세요.

첫 검색 후 이어서 포스트를 검색을 원하세요? 그러면 아래의 파라메터들을 추가로 사용하세요.

start_author: 검색된 마지막 포스트의 계정
start_permlink: 검색된 마지막 포스트의 permlink

서버로부터 받을 응답 자료

응답 자료의 키는 jsonrpc, result, id 3가지입니다. 그렇지만 result를 구성하는 포스트의 포맷이 복잡합니다.

{
    "jsonrpc": "2.0",
    "result": 검색된 포스트 배열,
    "id": 0
}

result를 구성하는 포스트의 포맷

bridge.get_ranked_posts API를 실행 결과로 받은 자료를 보고 파악된 내용을 아래와 같이 정리해 봅니다. (스팀 API 문서에서는 이에 대한 설명들이 없더군요. ㅠㅠ)

{
    "post_id": 포스트 번호,
    "author": 저자 계정,
    "permlink": 포스트 permlink,
    "category": 첫 태그,
    "title": 포스트 제목,
    "body": 포스트 내용,
    "json_metadata": {
        "tags": 포스트 태그 배열,
        "app": 포스트 작성시 사용 앱 (예: "nutbox/wormhole3")
    },
    "created": 작성일시(UTC),
    "updated": 최근 업데이트 일시(UTC),
    "depth": 0,
    "children": 0,
    "net_rshares": 164972753764,
    "is_paidout": 보상 지불 되었으면 true 그렇지 않으면 false,
    "payout_at": 보상 지급 일시(UTC),
    "payout": 0.031,
    "pending_payout_value": 미지급 보상 금액 ($ 단위),
    "author_payout_value": 지급된 저자 보상 금액 ($ 단위),
    "curator_payout_value": 지급된 큐레이션 보상 금액 ($ 단위),
    "promoted": "0.000 SBD",
    "replies": [],
    "active_votes": 보팅 배열 (보팅은 voter(보팅한 계정), rshares(문자열)로 구성),
    "author_reputation": 저자 계정의 명성도,
    "stats": {
        "hide": true or false,
        "gray": true or false,
        "total_votes": 보팅한 계정 수 (유효하지 않은 보팅은 제외되는 듯),
        "flag_weight": 0.0
    },
    "beneficiaries": 보상을 나눠 가질 수혜자 배열 (수혜자: account, weight(정수. 100%면, 10000)로 구성),
    "max_accepted_payout": 가능한 보상 최대값 (예: "1000000.000 SBD"),
    "percent_steem_dollars": 10000,
    "url": 포스트의 서브 URL (예: "/hive-139150/@ggagu/1588831319987224576"),
    "blacklists": 블랙리스트 배열 (예: ["reputation-0"]),
    "community": 포스트가 속한 커뮤니티의 태그 (예: "hive-139150"),
    "community_title": 포스트가 속한 커뮤니티 이름(예: "PIRCOIN · 해적 코인"),
    "author_role": 커뮤니티에서 저자의 역할 (예: "guest"),
    "author_title": 커뮤니티에서 저자의 별칭 (예: "깨굴깨굴 깨구리 노래를 한다~")
}