Skip to content

Latest commit

 

History

History
306 lines (188 loc) · 7.82 KB

README.md

File metadata and controls

306 lines (188 loc) · 7.82 KB
Raw

TGStat GO API Wrapper

LICENSE Go Go Report Card Godocs codecov

TGStat API written in Go

TGStat is service that collects information about different channels and chats

Installation

Make sure your project is using Go Modules (it will have a go.mod file in its root if it already is):

go mod init

Then, reference stripe-go in a Go program with import:

import (
	tgstat "github.com/helios-ag/tgstat-go"
	"github.com/helios-ag/tgstat-go/channels"
)

Run any of the normal go commands (build/install/test). The Go toolchain will resolve and fetch the stripe-go module automatically.

Alternatively, you can also explicitly go get the package into a project:

go get -u github.com/helios-ag/tgstat-go

Getting started

Step 1

Obtain key by authorizing on https://api.tgstat.ru/docs/ru/start/token.html

Step 2

After getting token, you must set token assigning it to tgstat.Token value.

Step 3

After setting you token, you can call, for example, method from channels package: channels.Get(context.Background(), "https://t.me/nim_ru")

Example below:

// example.go
package main

import (
	"context"
	"fmt"
	tgstat "github.com/helios-ag/tgstat-go"
	"github.com/helios-ag/tgstat-go/channels"
	"os"
)

func main() {
        ...

	tgstat.Token = "yourtoken"

	channelInfo, _, err := channels.Get(context.Background(), "https://t.me/nim_ru")

	if err != nil {
		fmt.Printf("error getting data: %v\n", err)
		os.Exit(1)
	}

	fmt.Print("Channel Info")
	...
	fmt.Printf("Title: %s\n", channelInfo.Response.Title)
	...
}

Step 4

Run example go build example.go

Examples

All examples available at examples repository

Available methods

Channels

Get Channel Info

Docs at: https://api.tgstat.ru/docs/ru/channels/get.html

func Get(ctx context.Context, channelId string)

Search among channels

Docs at: https://api.tgstat.ru/docs/ru/channels/search.html

func Search(ctx context.Context, request SearchRequest)

Get channel stat

Docs at: https://api.tgstat.ru/docs/ru/channels/search.html

func Search(ctx context.Context, request SearchRequest)

Get channel posts

Docs at: https://api.tgstat.ru/docs/ru/channels/posts.html

func Posts(ctx context.Context, request PostsRequest)

Get channel mentions

Docs at: https://api.tgstat.ru/docs/ru/channels/mentions.html

func Mentions(ctx context.Context, request ChannelMentionsRequest)

Get channel forwards

Docs at: https://api.tgstat.ru/docs/ru/channels/forwards.html

func (c Client) Forwards(ctx context.Context, request ChannelForwardRequest)

Get channel subscribers

Docs at: https://api.tgstat.ru/docs/ru/channels/subscribers.html

func Subscribers(ctx context.Context, request ChannelSubscribersRequest)

Get channel views

Docs at: https://api.tgstat.ru/docs/ru/channels/views.html

func Views(ctx context.Context, request ChannelViewsRequest)

Get channel average posts reach

Docs at: https://api.tgstat.ru/docs/ru/channels/avg-posts-reach.html

func AvgPostsReach(ctx context.Context, request ChannelViewsRequest)

Add channel

Docs at: https://api.tgstat.ru/docs/ru/channels/add.html

func Add(ctx context.Context, request ChannelAddRequest)

Get channel ERR rate

Docs at: https://api.tgstat.ru/channels/err

func Err(ctx context.Context, request ChannelViewsRequest)

Posts

Get post

Docs at: https://api.tgstat.ru/docs/ru/posts/get.html

func Get(ctx context.Context, postId string)

Post statistics

Docs at: https://api.tgstat.ru/docs/ru/posts/stat.html

func PostStat(ctx context.Context, request PostStatRequest)

Post search

Docs at: https://api.tgstat.ru/docs/ru/posts/search.html

func PostSearch(ctx context.Context, request PostSearchRequest)

and extended search

func PostSearchExtended(ctx context.Context, request PostSearchRequest)

Words

Mentions by period

Docs at: https://api.tgstat.ru/docs/ru/words/mentions-by-period.html

func MentionsByPeriod(ctx context.Context, request MentionPeriodRequest)

Mentions by channel

Docs at: https://api.tgstat.ru/words/mentions-by-channels

func MentionsByChannels(ctx context.Context, request MentionsByChannelRequest)

Database

Categories

Docs at: https://api.tgstat.ru/docs/ru/database/categories.html

func CategoriesGet(ctx context.Context, lang string)

Countries

Docs at: https://api.tgstat.ru/docs/ru/database/countries.html

func CountriesGet(ctx context.Context, lang string)

Languages

Docs at: https://api.tgstat.ru/docs/ru/database/languages.html

func LanguagesGet(ctx context.Context, lang string)

Usage

Statistics

Docs available at https://api.tgstat.ru/docs/ru/usage/stat.html

func Stat(ctx context.Context)

API Callback

Set Callback URl

Docs available at https://api.tgstat.ru/docs/ru/callback/set-callback-url.html

func SetCallback(ctx context.Context, callbackUrl string

Get Callback Info

Docs available at https://api.tgstat.ru/docs/ru/callback/get-callback-info.html

func GetCallbackInfo(ctx context.Context)

Subscribe to channel

Docs available at https://api.tgstat.ru/docs/ru/callback/subscribe-channel.html

func SubscribeChannel(ctx context.Context, request SubscribeChannelRequest)

Subscribe to word

Docs available at https://api.tgstat.ru/docs/ru/callback/subscribe-word.html

func SubscribeWord(ctx context.Context, request SubscribeWordRequest)

Subscriptions list

Docs available at https://api.tgstat.ru/docs/ru/callback/subscriptions-list.html

func SubscriptionsList(ctx context.Context, subscriptionsListRequest SubscriptionsListRequest)

Unsubscribe channel

Docs available at https://api.tgstat.ru/docs/ru/callback/unsubscribe.html

func Unsubscribe(ctx context.Context, subscriptionId string)