Skip to content

Commit 086f85a

Browse files
author
scrapebadger-bot
committed
chore: regenerate SDK from OpenAPI spec
1 parent 4d0f791 commit 086f85a

2 files changed

Lines changed: 50 additions & 5 deletions

File tree

README.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,48 @@
1+
# ScrapeBadger C# SDK
2+
3+
[![version](https://img.shields.io/nuget/v/ScrapeBadger)](https://www.nuget.org/packages/ScrapeBadger) [![CI](https://img.shields.io/github/actions/workflow/status/scrape-badger/scrapebadger-csharp/ci.yml?label=CI)](https://github.com/scrape-badger/scrapebadger-csharp/actions) [![license](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
4+
5+
Official **C#** SDK for [ScrapeBadger](https://scrapebadger.com) — one API key for
6+
30+ scraping APIs: Twitter/X, Reddit, Facebook, Instagram, TikTok, YouTube, Amazon, eBay,
7+
Walmart, Vinted, Google (18 products), Bing, Yahoo, ChatGPT, Perplexity, real estate, and
8+
any URL via the general Web Scraping API. Generated from the ScrapeBadger OpenAPI spec —
9+
always in sync with the API. ⚠️ This repository is regenerated automatically; don't send
10+
PRs here, request changes via the [roadmap](https://github.com/scrape-badger/roadmap).
11+
12+
📚 [API docs](https://docs.scrapebadger.com) · 🧰 [All SDKs](https://scrapebadger.com/sdks) · 🔑 [Get an API key](https://scrapebadger.com/auth/signup) — 1,000 free credits
13+
14+
## 🚀 Install
15+
16+
```
17+
dotnet add package ScrapeBadger
18+
```
19+
20+
## ⚡ Quick start
21+
22+
```csharp
23+
using ScrapeBadger.Api;
24+
using ScrapeBadger.Client;
25+
26+
var config = new Configuration();
27+
config.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
28+
29+
var twitter = new TwitterApi(config);
30+
var user = await twitter.TwitterGetUserByUsernameAsync("elonmusk");
31+
Console.WriteLine(user);
32+
```
33+
34+
Every scraper is available as its own API class (`TwitterApi`, `AmazonApi`, `GoogleApi`, …)
35+
with one method per endpoint — the full list is in the reference below.
36+
37+
## 🛠 Development
38+
39+
```sh
40+
dotnet build src/ScrapeBadger/ScrapeBadger.csproj # compile
41+
dotnet test # tests
42+
```
43+
44+
---
45+
146
# ScrapeBadger - the C# library for the ScrapeBadger API
247

348
Unified credit-based scraping API. https://docs.scrapebadger.com

ScrapeBadger.sln

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ Microsoft Visual Studio Solution File, Format Version 12.00
22
# Visual Studio 14
33
VisualStudioVersion = 14.0.25420.1
44
MinimumVisualStudioVersion = 10.0.40219.1
5-
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ScrapeBadger", "src\ScrapeBadger\ScrapeBadger.csproj", "{63D9A706-8FF4-4576-B8A9-E7F8C64E1AAB}"
5+
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ScrapeBadger", "src\ScrapeBadger\ScrapeBadger.csproj", "{B88E391A-7D78-4205-AE73-88E5E6C3C1FF}"
66
EndProject
77
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ScrapeBadger.Test", "src\ScrapeBadger.Test\ScrapeBadger.Test.csproj", "{19F1DEBC-DE5E-4517-8062-F000CD499087}"
88
EndProject
@@ -12,10 +12,10 @@ Global
1212
Release|Any CPU = Release|Any CPU
1313
EndGlobalSection
1414
GlobalSection(ProjectConfigurationPlatforms) = postSolution
15-
{63D9A706-8FF4-4576-B8A9-E7F8C64E1AAB}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
16-
{63D9A706-8FF4-4576-B8A9-E7F8C64E1AAB}.Debug|Any CPU.Build.0 = Debug|Any CPU
17-
{63D9A706-8FF4-4576-B8A9-E7F8C64E1AAB}.Release|Any CPU.ActiveCfg = Release|Any CPU
18-
{63D9A706-8FF4-4576-B8A9-E7F8C64E1AAB}.Release|Any CPU.Build.0 = Release|Any CPU
15+
{B88E391A-7D78-4205-AE73-88E5E6C3C1FF}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
16+
{B88E391A-7D78-4205-AE73-88E5E6C3C1FF}.Debug|Any CPU.Build.0 = Debug|Any CPU
17+
{B88E391A-7D78-4205-AE73-88E5E6C3C1FF}.Release|Any CPU.ActiveCfg = Release|Any CPU
18+
{B88E391A-7D78-4205-AE73-88E5E6C3C1FF}.Release|Any CPU.Build.0 = Release|Any CPU
1919
{19F1DEBC-DE5E-4517-8062-F000CD499087}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
2020
{19F1DEBC-DE5E-4517-8062-F000CD499087}.Debug|Any CPU.Build.0 = Debug|Any CPU
2121
{19F1DEBC-DE5E-4517-8062-F000CD499087}.Release|Any CPU.ActiveCfg = Release|Any CPU

0 commit comments

Comments
 (0)