DocumentationSDK / API Client

SDK and API Clients

ScrAPI is a standard REST API that can be consumed from any programming language using simple HTTP requests. For a more integrated developer experience, we provide an official SDK along with tools to generate typed clients in your language of choice.

When To Use an SDK

  • Type safety - Get compile-time checks and autocomplete in your IDE instead of building raw HTTP requests.
  • Faster integration - Skip boilerplate HTTP code and start scraping with a few lines.
  • Maintainability - SDK updates track API changes so your integration stays current.

Official .NET SDK

The official ScrAPI SDK for .NET is available on NuGet:

dotnet add package ScrAPI

Generate Clients for Other Languages

For languages without an official SDK, you can use Microsoft Kiota to generate a fully typed API client from the ScrAPI OpenAPI specification:

# Go
kiota generate --ebc -c ScrapiClient -n Scrapi -d https://api.scrapi.tech/openapi/v1.json -o ScrapiClientGo -l go
 
# Java
kiota generate --ebc -c ScrapiClient -n Scrapi -d https://api.scrapi.tech/openapi/v1.json -o ScrapiClientJava -l java
 
# PHP
kiota generate --ebc -c ScrapiClient -n Scrapi -d https://api.scrapi.tech/openapi/v1.json -o ScrapiClientPhp -l php
 
# Python
kiota generate --ebc -c ScrapiClient -n Scrapi -d https://api.scrapi.tech/openapi/v1.json -o ScrapiClientPython -l python
 
# Ruby
kiota generate --ebc -c ScrapiClient -n Scrapi -d https://api.scrapi.tech/openapi/v1.json -o ScrapiClientRuby -l ruby
 
# TypeScript
kiota generate --ebc -c ScrapiClient -n Scrapi -d https://api.scrapi.tech/openapi/v1.json -o ScrapiClientTypeScript -l typescript
 
# Dart
kiota generate --ebc -c ScrapiClient -n Scrapi -d https://api.scrapi.tech/openapi/v1.json -o ScrapiClientDart -l dart

Quick Start with the Playground

If you just want to generate ready-to-use code snippets without installing an SDK, head to the Playground. Configure the scraping options you need and copy the generated code for your language.