All Downloads are FREE. Search and download functionalities are using the official Maven repository.

io.blockfrost.sdk.impl.retrofit.PoolsApi Maven / Gradle / Ivy

package io.blockfrost.sdk.impl.retrofit;

import io.blockfrost.sdk.api.model.*;
import retrofit2.Call;
import retrofit2.http.GET;
import retrofit2.http.Header;
import retrofit2.http.Path;
import retrofit2.http.Query;

import java.util.List;

public interface PoolsApi {
    /**
     * List of networkStake pools
     * List of registered networkStake pools.
     *
     * @param count The numbers of pools per page. (optional, default to 100)
     * @param page  The page number for listing the results. (optional, default to 1)
     * @param order The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last.  (optional, default to asc)
     * @return Call<List<String>>
     */
    @GET("pools")
    Call> poolsGet(
            @Header("project_id") String projectId,
            @Query("count") Integer count,
            @Query("page") Integer page,
            @Query("order") String order
    );

    /**
     * NetworkStake pool blocks
     * List of networkStake pools blocks.
     *
     * @param poolId Bech32 or hexadecimal pool ID. (required)
     * @param count  The number of results displayed on one page. (optional, default to 100)
     * @param page   The page number for listing the results. (optional, default to 1)
     * @param order  The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last.  (optional, default to asc)
     * @return Call<List<String>>
     */
    @GET("pools/{pool_id}/blocks")
    Call> poolsPoolIdBlocksGet(
            @Header("project_id") String projectId,
            @Path("pool_id") String poolId,
            @Query("count") Integer count,
            @Query("page") Integer page,
            @Query("order") String order
    );

    /**
     * NetworkStake pool delegators
     * List of current networkStake pools delegators.
     *
     * @param poolId Bech32 or hexadecimal pool ID. (required)
     * @param count  The number of results displayed on one page. (optional, default to 100)
     * @param page   The page number for listing the results. (optional, default to 1)
     * @param order  The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last.  (optional, default to asc)
     * @return Call<List<Object>>
     */
    @GET("pools/{pool_id}/delegators")
    Call> poolsPoolIdDelegatorsGet(
            @Header("project_id") String projectId,
            @Path("pool_id") String poolId,
            @Query("count") Integer count,
            @Query("page") Integer page,
            @Query("order") String order
    );

    /**
     * Specific networkStake pool
     * Pool information.
     *
     * @param poolId Bech32 or hexadecimal pool ID. (required)
     * @return Call<Pool>
     */
    @GET("pools/{pool_id}")
    Call poolsPoolIdGet(
            @Header("project_id") String projectId,
            @Path("pool_id") String poolId
    );

    /**
     * NetworkStake pool history
     * History of networkStake pool parameters over epochs.
     *
     * @param poolId Bech32 or hexadecimal pool ID. (required)
     * @param count  The number of results displayed on one page. (optional, default to 100)
     * @param page   The page number for listing the results (optional, default to 1)
     * @param order  The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last.  (optional, default to asc)
     * @return Call<List<PoolHistory>>
     */
    @GET("pools/{pool_id}/history")
    Call> poolsPoolIdHistoryGet(
            @Header("project_id") String projectId,
            @Path("pool_id") String poolId,
            @Query("count") Integer count,
            @Query("page") Integer page,
            @Query("order") String order
    );

    /**
     * NetworkStake pool metadata
     * NetworkStake pool registration metadata.
     *
     * @param poolId Bech32 or hexadecimal pool ID. (required)
     * @return Call<PoolMetadata>
     */
    @GET("pools/{pool_id}/metadata")
    Call poolsPoolIdMetadataGet(
            @Header("project_id") String projectId,
            @Path("pool_id") String poolId
    );

    /**
     * NetworkStake pool relays
     * Relays of a networkStake pool.
     *
     * @param poolId Bech32 or hexadecimal pool ID. (required)
     * @return Call<List<Object>>
     */
    @GET("pools/{pool_id}/relays")
    Call> poolsPoolIdRelaysGet(
            @Header("project_id") String projectId,
            @Path("pool_id") String poolId
    );

    /**
     * NetworkStake pool updates
     * List of certificate updates to the networkStake pool.
     *
     * @param poolId Bech32 or hexadecimal pool ID. (required)
     * @param count  The number of results displayed on one page. (optional, default to 100)
     * @param page   The page number for listing the results. (optional, default to 1)
     * @param order  The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last.  (optional, default to asc)
     * @return Call<List<Object>>
     */
    @GET("pools/{pool_id}/updates")
    Call> poolsPoolIdUpdatesGet(
            @Header("project_id") String projectId,
            @Path("pool_id") String poolId,
            @Query("count") Integer count,
            @Query("page") Integer page,
            @Query("order") String order
    );

    /**
     * List of retired networkStake pools
     * List of already retired pools.
     *
     * @param count The numbers of pools per page. (optional, default to 100)
     * @param page  The page number for listing the results. (optional, default to 1)
     * @param order The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last.  (optional, default to asc)
     * @return Call<List<Object>>
     */
    @GET("pools/retired")
    Call> poolsRetiredGet(
            @Header("project_id") String projectId,
            @Query("count") Integer count,
            @Query("page") Integer page,
            @Query("order") String order
    );

    /**
     * List of retiring networkStake pools
     * List of networkStake pools retiring in the upcoming epochs
     *
     * @param count The number of results displayed on one page. (optional, default to 100)
     * @param page  The page number for listing the results. (optional, default to 1)
     * @param order The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last.  (optional, default to asc)
     * @return Call<List<Object>>
     */
    @GET("pools/retiring")
    Call> poolsRetiringGet(
            @Header("project_id") String projectId,
            @Query("count") Integer count,
            @Query("page") Integer page,
            @Query("order") String order
    );

}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy