Skip to content

Latest commit

 

History

History
2286 lines (1566 loc) · 22.9 KB

reference.md

File metadata and controls

2286 lines (1566 loc) · 22.9 KB

Reference

client.start(...)

🔌 Usage

from scrapybara import Scrapybara

client = Scrapybara(
    api_key="YOUR_API_KEY",
)
client.start()

⚙️ Parameters

instance_type: typing.Optional[DeploymentConfigInstanceType]

timeout_hours: typing.Optional[float]

blocked_domains: typing.Optional[typing.Sequence[str]]

resolution: typing.Optional[typing.Sequence[int]]

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.get(...)

🔌 Usage

from scrapybara import Scrapybara

client = Scrapybara(
    api_key="YOUR_API_KEY",
)
client.get(
    instance_id="instance_id",
)

⚙️ Parameters

instance_id: str

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.get_instances()

🔌 Usage

from scrapybara import Scrapybara

client = Scrapybara(
    api_key="YOUR_API_KEY",
)
client.get_instances()

⚙️ Parameters

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.get_auth_states()

🔌 Usage

from scrapybara import Scrapybara

client = Scrapybara(
    api_key="YOUR_API_KEY",
)
client.get_auth_states()

⚙️ Parameters

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

Instance

client.instance.screenshot(...)

🔌 Usage

from scrapybara import Scrapybara

client = Scrapybara(
    api_key="YOUR_API_KEY",
)
client.instance.screenshot(
    instance_id="instance_id",
)

⚙️ Parameters

instance_id: str

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.instance.get_stream_url(...)

🔌 Usage

from scrapybara import Scrapybara

client = Scrapybara(
    api_key="YOUR_API_KEY",
)
client.instance.get_stream_url(
    instance_id="instance_id",
)

⚙️ Parameters

instance_id: str

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.instance.computer(...)

🔌 Usage

from scrapybara import Scrapybara
from scrapybara.instance import Request_MoveMouse

client = Scrapybara(
    api_key="YOUR_API_KEY",
)
client.instance.computer(
    instance_id="instance_id",
    request=Request_MoveMouse(
        coordinates=[1],
    ),
)

⚙️ Parameters

instance_id: str

request: Request

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.instance.bash(...)

🔌 Usage

from scrapybara import Scrapybara

client = Scrapybara(
    api_key="YOUR_API_KEY",
)
client.instance.bash(
    instance_id="instance_id",
)

⚙️ Parameters

instance_id: str

command: typing.Optional[str]

session: typing.Optional[int]

restart: typing.Optional[bool]

list_sessions: typing.Optional[bool]

check_session: typing.Optional[int]

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.instance.edit(...)

🔌 Usage

from scrapybara import Scrapybara

client = Scrapybara(
    api_key="YOUR_API_KEY",
)
client.instance.edit(
    instance_id="instance_id",
    command="view",
    path="path",
)

⚙️ Parameters

instance_id: str

command: Command

path: str

file_text: typing.Optional[str]

view_range: typing.Optional[typing.Sequence[int]]

old_str: typing.Optional[str]

new_str: typing.Optional[str]

insert_line: typing.Optional[int]

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.instance.file(...)

🔌 Usage

from scrapybara import Scrapybara

client = Scrapybara(
    api_key="YOUR_API_KEY",
)
client.instance.file(
    instance_id="instance_id",
    command="command",
)

⚙️ Parameters

instance_id: str

command: str

path: typing.Optional[str]

content: typing.Optional[str]

mode: typing.Optional[str]

encoding: typing.Optional[str]

view_range: typing.Optional[typing.Sequence[int]]

recursive: typing.Optional[bool]

src: typing.Optional[str]

dst: typing.Optional[str]

old_str: typing.Optional[str]

new_str: typing.Optional[str]

line: typing.Optional[int]

text: typing.Optional[str]

lines: typing.Optional[typing.Sequence[int]]

all_occurrences: typing.Optional[bool]

pattern: typing.Optional[str]

case_sensitive: typing.Optional[bool]

line_numbers: typing.Optional[bool]

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.instance.upload(...)

📝 Description

Upload a file to the instance.

🔌 Usage

from scrapybara import Scrapybara

client = Scrapybara(
    api_key="YOUR_API_KEY",
)
client.instance.upload(
    instance_id="instance_id",
    path="path",
)

⚙️ Parameters

instance_id: str

file: `from future import annotations

core.File` — See core.File for more documentation

path: str

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.instance.stop(...)

🔌 Usage

from scrapybara import Scrapybara

client = Scrapybara(
    api_key="YOUR_API_KEY",
)
client.instance.stop(
    instance_id="instance_id",
)

⚙️ Parameters

instance_id: str

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.instance.pause(...)

🔌 Usage

from scrapybara import Scrapybara

client = Scrapybara(
    api_key="YOUR_API_KEY",
)
client.instance.pause(
    instance_id="instance_id",
)

⚙️ Parameters

instance_id: str

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.instance.resume(...)

🔌 Usage

from scrapybara import Scrapybara

client = Scrapybara(
    api_key="YOUR_API_KEY",
)
client.instance.resume(
    instance_id="instance_id",
)

⚙️ Parameters

instance_id: str

timeout_hours: typing.Optional[float]

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

Browser

client.browser.start(...)

🔌 Usage

from scrapybara import Scrapybara

client = Scrapybara(
    api_key="YOUR_API_KEY",
)
client.browser.start(
    instance_id="instance_id",
)

⚙️ Parameters

instance_id: str

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.browser.get_cdp_url(...)

🔌 Usage

from scrapybara import Scrapybara

client = Scrapybara(
    api_key="YOUR_API_KEY",
)
client.browser.get_cdp_url(
    instance_id="instance_id",
)

⚙️ Parameters

instance_id: str

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.browser.get_current_url(...)

🔌 Usage

from scrapybara import Scrapybara

client = Scrapybara(
    api_key="YOUR_API_KEY",
)
client.browser.get_current_url(
    instance_id="instance_id",
)

⚙️ Parameters

instance_id: str

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.browser.save_auth(...)

🔌 Usage

from scrapybara import Scrapybara

client = Scrapybara(
    api_key="YOUR_API_KEY",
)
client.browser.save_auth(
    instance_id="instance_id",
)

⚙️ Parameters

instance_id: str

name: typing.Optional[str]

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.browser.modify_auth(...)

🔌 Usage

from scrapybara import Scrapybara

client = Scrapybara(
    api_key="YOUR_API_KEY",
)
client.browser.modify_auth(
    instance_id="instance_id",
    auth_state_id="auth_state_id",
)

⚙️ Parameters

instance_id: str

auth_state_id: str

name: typing.Optional[str]

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.browser.authenticate(...)

🔌 Usage

from scrapybara import Scrapybara

client = Scrapybara(
    api_key="YOUR_API_KEY",
)
client.browser.authenticate(
    instance_id="instance_id",
    auth_state_id="auth_state_id",
)

⚙️ Parameters

instance_id: str

auth_state_id: str

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.browser.stop(...)

🔌 Usage

from scrapybara import Scrapybara

client = Scrapybara(
    api_key="YOUR_API_KEY",
)
client.browser.stop(
    instance_id="instance_id",
)

⚙️ Parameters

instance_id: str

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

Code

client.code.execute(...)

🔌 Usage

from scrapybara import Scrapybara

client = Scrapybara(
    api_key="YOUR_API_KEY",
)
client.code.execute(
    instance_id="instance_id",
    code="code",
)

⚙️ Parameters

instance_id: str

code: str

kernel_name: typing.Optional[str]

timeout: typing.Optional[int]

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

Notebook

client.notebook.list_kernels(...)

🔌 Usage

from scrapybara import Scrapybara

client = Scrapybara(
    api_key="YOUR_API_KEY",
)
client.notebook.list_kernels(
    instance_id="instance_id",
)

⚙️ Parameters

instance_id: str

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.notebook.create(...)

🔌 Usage

from scrapybara import Scrapybara

client = Scrapybara(
    api_key="YOUR_API_KEY",
)
client.notebook.create(
    instance_id="instance_id",
    name="name",
)

⚙️ Parameters

instance_id: str

name: str

kernel_name: typing.Optional[str]

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.notebook.get(...)

🔌 Usage

from scrapybara import Scrapybara

client = Scrapybara(
    api_key="YOUR_API_KEY",
)
client.notebook.get(
    instance_id="instance_id",
    notebook_id="notebook_id",
)

⚙️ Parameters

instance_id: str

notebook_id: str

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.notebook.delete(...)

🔌 Usage

from scrapybara import Scrapybara

client = Scrapybara(
    api_key="YOUR_API_KEY",
)
client.notebook.delete(
    instance_id="instance_id",
    notebook_id="notebook_id",
)

⚙️ Parameters

instance_id: str

notebook_id: str

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.notebook.add_cell(...)

🔌 Usage

from scrapybara import Scrapybara

client = Scrapybara(
    api_key="YOUR_API_KEY",
)
client.notebook.add_cell(
    instance_id="instance_id",
    notebook_id="notebook_id",
    type="code",
    content="content",
)

⚙️ Parameters

instance_id: str

notebook_id: str

type: CellType

content: str

metadata: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.notebook.execute_cell(...)

🔌 Usage

from scrapybara import Scrapybara

client = Scrapybara(
    api_key="YOUR_API_KEY",
)
client.notebook.execute_cell(
    instance_id="instance_id",
    notebook_id="notebook_id",
    cell_id="cell_id",
)

⚙️ Parameters

instance_id: str

notebook_id: str

cell_id: str

timeout: typing.Optional[int]

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.notebook.execute(...)

🔌 Usage

from scrapybara import Scrapybara

client = Scrapybara(
    api_key="YOUR_API_KEY",
)
client.notebook.execute(
    instance_id="instance_id",
    notebook_id="notebook_id",
)

⚙️ Parameters

instance_id: str

notebook_id: str

timeout: typing.Optional[int]

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

Env

client.env.get(...)

🔌 Usage

from scrapybara import Scrapybara

client = Scrapybara(
    api_key="YOUR_API_KEY",
)
client.env.get(
    instance_id="instance_id",
)

⚙️ Parameters

instance_id: str

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.env.set(...)

🔌 Usage

from scrapybara import Scrapybara

client = Scrapybara(
    api_key="YOUR_API_KEY",
)
client.env.set(
    instance_id="instance_id",
    variables={"key": "value"},
)

⚙️ Parameters

instance_id: str

variables: typing.Dict[str, str]

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.env.delete(...)

🔌 Usage

from scrapybara import Scrapybara

client = Scrapybara(
    api_key="YOUR_API_KEY",
)
client.env.delete(
    instance_id="instance_id",
    keys=["keys"],
)

⚙️ Parameters

instance_id: str

keys: typing.Sequence[str]

request_options: typing.Optional[RequestOptions] — Request-specific configuration.