github.com/line/ostracon@v1.0.10-0.20230328032236-7f20145f065d/rpc/core/README.md (about)

     1  # Ostracon RPC
     2  
     3  ## Pagination
     4  
     5  Requests that return multiple items will be paginated to 30 items by default.
     6  You can specify further pages with the ?page parameter. You can also set a
     7  custom page size up to 100 with the ?per_page parameter.
     8  
     9  ## Subscribing to events
    10  
    11  The user can subscribe to events emitted by Ostracon, using `/subscribe`. If
    12  the maximum number of clients is reached or the client has too many
    13  subscriptions, an error will be returned. The subscription timeout is 5 sec.
    14  Each subscription has a buffer to accommodate short bursts of events or some
    15  slowness in clients. If the buffer gets full, the subscription will be canceled
    16  ("client is not pulling messages fast enough"). If Ostracon exits, all
    17  subscriptions are canceled ("Ostracon exited"). The user can unsubscribe
    18  using either `/unsubscribe` or `/unsubscribe_all`.