Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions src/urlscan/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -496,6 +496,21 @@ def get_dom(self, uuid: str) -> str:
"""
return self.get_text(f"/dom/{uuid}/")

def get_response(self, file_hash: str) -> str:
"""Get a (Script|Document|Fetch|XHR) response in plain text format by SHA256 hash.

Args:
file_hash (str): SHA256 hash of the response.

Returns:
str: Response content as a string.

Reference:
https://docs.urlscan.io/apis/urlscan-openapi/scanning/response

"""
return self.get_text(f"/responses/{file_hash}/")

def search(
self,
q: str = "",
Expand Down
9 changes: 9 additions & 0 deletions tests/integration/test_client.py
Original file line number Diff line number Diff line change
Expand Up @@ -46,3 +46,12 @@ def test_get_user_agents(client: Client):
user_agents = client.get_user_agents()
assert isinstance(user_agents, dict)
assert len(user_agents) > 0


@pytest.mark.integration
def test_get_response(client: Client):
# hash of an empty content/string
res = client.get_response(
"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"
)
assert res == ""
9 changes: 9 additions & 0 deletions tests/unit/test_client.py
Original file line number Diff line number Diff line change
Expand Up @@ -530,3 +530,12 @@ def test_error_3(client: Client, httpserver: HTTPServer):
assert exc.code is None
assert exc.type is None
assert exc.errors is not None


def test_get_response(client: Client, httpserver: HTTPServer):
httpserver.expect_request("/responses/dummy/", method="GET").respond_with_data(
"dummy", content_type="text/plain"
)

got = client.get_response("dummy")
assert got == "dummy"