Documentation
¶
Overview ¶
Package reddit is Crawlora's Reddit API client for 39 endpoints, covering search, post and comment details, subreddit feeds, user history, domain listings, trends, and leads. API documentation: https://crawlora.net/docs?utm_source=pkg.go.dev&utm_medium=referral&utm_campaign=platform-clients&utm_content=reddit-go-api-docs
Index ¶
- Constants
- func OperationIDs() []string
- type Client
- func (c *Client) ArchiveCommentsIds(ctx context.Context, params Params) (any, error)
- func (c *Client) ArchiveCommentsSearch(ctx context.Context, params Params) (any, error)
- func (c *Client) ArchiveCommentsTree(ctx context.Context, params Params) (any, error)
- func (c *Client) ArchivePostsIds(ctx context.Context, params Params) (any, error)
- func (c *Client) ArchivePostsSearch(ctx context.Context, params Params) (any, error)
- func (c *Client) ArchiveSubredditsSearch(ctx context.Context, params Params) (any, error)
- func (c *Client) ArchiveTimeSeries(ctx context.Context, params Params) (any, error)
- func (c *Client) Call(ctx context.Context, operationID string, params Params) (any, error)
- func (c *Client) Close() error
- func (c *Client) Comment(ctx context.Context, params Params) (any, error)
- func (c *Client) CommentAwards(ctx context.Context, params Params) (any, error)
- func (c *Client) Comments(ctx context.Context, params Params) (any, error)
- func (c *Client) DomainPosts(ctx context.Context, params Params) (any, error)
- func (c *Client) Leads(ctx context.Context, params Params) (any, error)
- func (c *Client) Popular(ctx context.Context, params Params) (any, error)
- func (c *Client) Post(ctx context.Context, params Params) (any, error)
- func (c *Client) PostAwards(ctx context.Context, params Params) (any, error)
- func (c *Client) PostsByIds(ctx context.Context, params Params) (any, error)
- func (c *Client) Search(ctx context.Context, params Params) (any, error)
- func (c *Client) SearchComments(ctx context.Context, params Params) (any, error)
- func (c *Client) SearchPeople(ctx context.Context, params Params) (any, error)
- func (c *Client) SubredditAbout(ctx context.Context, params Params) (any, error)
- func (c *Client) SubredditComments(ctx context.Context, params Params) (any, error)
- func (c *Client) SubredditFlairs(ctx context.Context, params Params) (any, error)
- func (c *Client) SubredditHighlights(ctx context.Context, params Params) (any, error)
- func (c *Client) SubredditLeaderboardCategories(ctx context.Context, params Params) (any, error)
- func (c *Client) SubredditPosts(ctx context.Context, params Params) (any, error)
- func (c *Client) SubredditRules(ctx context.Context, params Params) (any, error)
- func (c *Client) SubredditUserFlairs(ctx context.Context, params Params) (any, error)
- func (c *Client) SubredditWiki(ctx context.Context, params Params) (any, error)
- func (c *Client) SubredditsDiscover(ctx context.Context, params Params) (any, error)
- func (c *Client) SubredditsPosts(ctx context.Context, params Params) (any, error)
- func (c *Client) SubredditsSearch(ctx context.Context, params Params) (any, error)
- func (c *Client) SubredditsSuggest(ctx context.Context, params Params) (any, error)
- func (c *Client) Topics(ctx context.Context, params Params) (any, error)
- func (c *Client) TopicsBroad(ctx context.Context, params Params) (any, error)
- func (c *Client) TopicsSearch(ctx context.Context, params Params) (any, error)
- func (c *Client) Trends(ctx context.Context, params Params) (any, error)
- func (c *Client) UserComments(ctx context.Context, params Params) (any, error)
- func (c *Client) UserPosts(ctx context.Context, params Params) (any, error)
- func (c *Client) UserProfile(ctx context.Context, params Params) (any, error)
- type Params
Examples ¶
Constants ¶
const ( DefaultBaseURL = "https://api.crawlora.net/api/v1" Version = "0.3.0" )
const OperationCount = 39
OperationCount reports how many selected-platform operations this module exposes.
Variables ¶
This section is empty.
Functions ¶
func OperationIDs ¶
func OperationIDs() []string
OperationIDs returns the selected operation IDs in stable sorted order.
Types ¶
type Client ¶
Client calls only the operation IDs included in this platform module.
func NewClient ¶
NewClient creates a client using the supplied API key, or CRAWLORA_API_KEY when empty.
func (*Client) ArchiveCommentsIds ¶ added in v0.3.0
ArchiveCommentsIds calls the reddit-archive-comments-ids operation.
func (*Client) ArchiveCommentsSearch ¶ added in v0.3.0
ArchiveCommentsSearch calls the reddit-archive-comments-search operation.
func (*Client) ArchiveCommentsTree ¶ added in v0.3.0
ArchiveCommentsTree calls the reddit-archive-comments-tree operation.
func (*Client) ArchivePostsIds ¶ added in v0.3.0
ArchivePostsIds calls the reddit-archive-posts-ids operation.
func (*Client) ArchivePostsSearch ¶ added in v0.3.0
ArchivePostsSearch calls the reddit-archive-posts-search operation.
func (*Client) ArchiveSubredditsSearch ¶ added in v0.3.0
ArchiveSubredditsSearch calls the reddit-archive-subreddits-search operation.
func (*Client) ArchiveTimeSeries ¶ added in v0.3.0
ArchiveTimeSeries calls the reddit-archive-time-series operation.
func (*Client) Call ¶
Call executes a selected platform operation by operation ID.
Example ¶
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
w.Header().Set("Content-Type", "application/json")
_, _ = w.Write([]byte(`{"ok":true}`))
}))
defer server.Close()
client := NewClient("your-crawlora-api-key")
client.BaseURL = server.URL + "/api/v1"
client.HTTPClient = server.Client()
result, err := client.Call(context.Background(), "reddit-archive-comments-ids", Params{"ids": "sample"})
if err != nil {
panic(err)
}
fmt.Println(result.(map[string]any)["ok"])
Output: true
func (*Client) CommentAwards ¶ added in v0.3.0
CommentAwards calls the reddit-comment-awards operation.
func (*Client) DomainPosts ¶
DomainPosts calls the reddit-domain-posts operation.
func (*Client) PostAwards ¶ added in v0.3.0
PostAwards calls the reddit-post-awards operation.
func (*Client) PostsByIds ¶ added in v0.3.0
PostsByIds calls the reddit-posts-by-ids operation.
func (*Client) SearchComments ¶ added in v0.3.0
SearchComments calls the reddit-search-comments operation.
func (*Client) SearchPeople ¶ added in v0.3.0
SearchPeople calls the reddit-search-people operation.
func (*Client) SubredditAbout ¶
SubredditAbout calls the reddit-subreddit-about operation.
func (*Client) SubredditComments ¶
SubredditComments calls the reddit-subreddit-comments operation.
func (*Client) SubredditFlairs ¶ added in v0.3.0
SubredditFlairs calls the reddit-subreddit-flairs operation.
func (*Client) SubredditHighlights ¶ added in v0.3.0
SubredditHighlights calls the reddit-subreddit-highlights operation.
func (*Client) SubredditLeaderboardCategories ¶ added in v0.3.0
SubredditLeaderboardCategories calls the reddit-subreddit-leaderboard-categories operation.
func (*Client) SubredditPosts ¶
SubredditPosts calls the reddit-subreddit-posts operation.
func (*Client) SubredditRules ¶ added in v0.3.0
SubredditRules calls the reddit-subreddit-rules operation.
func (*Client) SubredditUserFlairs ¶ added in v0.3.0
SubredditUserFlairs calls the reddit-subreddit-user-flairs operation.
func (*Client) SubredditWiki ¶ added in v0.3.0
SubredditWiki calls the reddit-subreddit-wiki operation.
func (*Client) SubredditsDiscover ¶ added in v0.3.0
SubredditsDiscover calls the reddit-subreddits-discover operation.
func (*Client) SubredditsPosts ¶
SubredditsPosts calls the reddit-subreddits-posts operation.
func (*Client) SubredditsSearch ¶ added in v0.3.0
SubredditsSearch calls the reddit-subreddits-search operation.
func (*Client) SubredditsSuggest ¶ added in v0.3.0
SubredditsSuggest calls the reddit-subreddits-suggest operation.
func (*Client) TopicsBroad ¶ added in v0.3.0
TopicsBroad calls the reddit-topics-broad operation.
func (*Client) TopicsSearch ¶ added in v0.3.0
TopicsSearch calls the reddit-topics-search operation.
func (*Client) UserComments ¶
UserComments calls the reddit-user-comments operation.