Skip to content

SignalAPI.md

Latest commit

 

History

History
237 lines (157 loc) · 6.63 KB

SignalAPI.md

File metadata and controls

237 lines (157 loc) · 6.63 KB
Raw

\SignalAPI

All URIs are relative to https://api-mainnet.celenium.io/v1

Method HTTP request Description
GetUpgrade Get /signal/upgrade/{version} Get upgrade by version
ListSignal Get /signal List signals
ListUpgrades Get /signal/upgrade List upgrades

GetUpgrade

ResponsesUpgrade GetUpgrade(ctx, version).Execute()

Get upgrade by version

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/celenium-io/celenium-api-go"
)

func main() {
	version := int64(789) // int64 | Upgrade version

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.SignalAPI.GetUpgrade(context.Background(), version).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SignalAPI.GetUpgrade``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetUpgrade`: ResponsesUpgrade
	fmt.Fprintf(os.Stdout, "Response from `SignalAPI.GetUpgrade`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
version int64 Upgrade version

Other Parameters

Other parameters are passed through a pointer to a apiGetUpgradeRequest struct via the builder pattern

Name Type Description Notes

Return type

ResponsesUpgrade

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListSignal

[]ResponsesSignalVersion ListSignal(ctx).Version(version).ValidatorId(validatorId).TxHash(txHash).Limit(limit).Offset(offset).From(from).To(to).Sort(sort).Execute()

List signals

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/celenium-io/celenium-api-go"
)

func main() {
	version := int64(789) // int64 | Version (optional)
	validatorId := int64(789) // int64 | Validator internal id (optional)
	txHash := "txHash_example" // string | Transaction hash (optional)
	limit := int32(56) // int32 | Count of requested entities (optional)
	offset := int32(56) // int32 | Offset (optional)
	from := int64(789) // int64 | Time from in unix timestamp (optional)
	to := int64(789) // int64 | Time to in unix timestamp (optional)
	sort := "sort_example" // string | Sort order. Default: desc (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.SignalAPI.ListSignal(context.Background()).Version(version).ValidatorId(validatorId).TxHash(txHash).Limit(limit).Offset(offset).From(from).To(to).Sort(sort).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SignalAPI.ListSignal``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ListSignal`: []ResponsesSignalVersion
	fmt.Fprintf(os.Stdout, "Response from `SignalAPI.ListSignal`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiListSignalRequest struct via the builder pattern

Name Type Description Notes
version int64 Version
validatorId int64 Validator internal id
txHash string Transaction hash
limit int32 Count of requested entities
offset int32 Offset
from int64 Time from in unix timestamp
to int64 Time to in unix timestamp
sort string Sort order. Default: desc

Return type

[]ResponsesSignalVersion

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListUpgrades

[]ResponsesUpgrade ListUpgrades(ctx).Height(height).TxHash(txHash).Signer(signer).Limit(limit).Offset(offset).Sort(sort).Execute()

List upgrades

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/celenium-io/celenium-api-go"
)

func main() {
	height := int64(789) // int64 | Number of block (optional)
	txHash := "txHash_example" // string | Transaction hash (optional)
	signer := "signer_example" // string | Signer address (optional)
	limit := int32(56) // int32 | Count of requested entities (optional)
	offset := int32(56) // int32 | Offset (optional)
	sort := "sort_example" // string | Sort order. Default: desc (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.SignalAPI.ListUpgrades(context.Background()).Height(height).TxHash(txHash).Signer(signer).Limit(limit).Offset(offset).Sort(sort).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SignalAPI.ListUpgrades``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ListUpgrades`: []ResponsesUpgrade
	fmt.Fprintf(os.Stdout, "Response from `SignalAPI.ListUpgrades`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiListUpgradesRequest struct via the builder pattern

Name Type Description Notes
height int64 Number of block
txHash string Transaction hash
signer string Signer address
limit int32 Count of requested entities
offset int32 Offset
sort string Sort order. Default: desc

Return type

[]ResponsesUpgrade

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]