Skip to main content

Async Python client for Grok mobile gRPC API

Project description

Grok3API

Python Reverse engineered

Stars Forks Issues

An asynchronous library for interacting with Grok via the mobile gRPC channel: sending messages, streaming responses, parsing protobuf chunks, and retrieving structured API data.


➡ Ru README

Features

  • asynchronous client
  • streaming responses via new_ask_stream()
  • regular requests via new_ask()
  • protobuf/gRPC framing
  • typed Pydantic models
  • streaming chunk parsing
  • REST/gRPC/stream error handling
  • support for metadata/tool responses/search results

Installation

pip install git+ssh://git@github.com/boykopovar/Grok3API.git -U

Requirements

  • Python 3.8+
  • aiohttp
  • coincurve

Streaming Example

import asyncio

from grok3api.client import GrokClient
from grok3api.types.request import ChatRequest
from grok3api.types import TokenChunk


async def main():
    async with GrokClient() as client:
        while True:
            print("\nGrok: ", end="")

            async for chunk in client.new_ask_stream(
                request=ChatRequest(
                    message=input("\nYou: "),
                    temporary=False
                ),
                chunks_white_list=(TokenChunk,)
            ):
                print(chunk.token, end="", flush=True)


if __name__ == "__main__":
    asyncio.run(main())

Standard Request

import asyncio

from grok3api.client import GrokClient
from grok3api.types.request import ChatRequest


async def main():
    async with GrokClient() as client:
        response = await client.new_ask(
            ChatRequest(
                message="Hello",
                temporary=False
            )
        )

        print(response.text)
        print(response.model_response)


if __name__ == "__main__":
    asyncio.run(main())

Continue started conversation

import asyncio

from grok3api.client import GrokClient
from grok3api.types.request import ChatRequest, AddResponseRequest


async def main():
    async with GrokClient() as client:
        first = await client.new_ask(
            ChatRequest(
                message="Hello",
                temporary=False
            )
        )

        second = await client.add_response(
            AddResponseRequest(
                conversation_id=first.conversation.conversation_id,
                message="How are you?"
            )
        )

        print(second.text)


if __name__ == "__main__":
    asyncio.run(main())

Pydantic Models

All models fully match the actual protobuf/gRPC API responses.

The library does not include:

  • simplified structures
  • artificial abstraction layers
  • field normalization
  • payload field renaming
  • hiding original API values

Supported

Response Chunks

  • TokenChunk
  • ModelResponseChunk
  • FinalMetadataChunk
  • SurveyChunk
  • ConversationChunk
  • TitleChunk

Response Models

  • AskResponse
  • ModelResponse
  • FinalMetadata
  • Conversation
  • Survey
  • ResponseStep
  • ToolUsageResult
  • WebSearchResult
  • XPost
  • RagResult
  • CollectionSearchResultItem
  • ConnectorSearchResultItem
  • StreamError

Tool Responses

  • web search
  • X/Twitter search
  • RAG results
  • connector search
  • collection search
  • memory updates
  • code execution
  • image generation
  • video generation
  • audio generation

Error Handling

from grok3api.types.exceptions import (
    GrokApiError,
    GrokRestError,
    GrokGrpcError,
    GrokRateLimitError,
    GrokUnderHeavyUsageError,
    GrokStreamError,
    GrokUnavailableRegionError,
    GrokTooManyRequestsError
)

How the Client Works

  1. the protobuf request is serialized into a binary payload
  2. the payload is wrapped into a gRPC frame
  3. the request is sent to the mobile gRPC endpoint
  4. the client reads the streaming response
  5. protobuf chunks are decoded into Pydantic models

Disclaimer

This project is not affiliated with xAI and is not an official SDK.

This is an independent implementation of the mobile Grok API obtained through reverse engineering.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

grok3api-0.2.1.tar.gz (17.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

grok3api-0.2.1-py3-none-any.whl (22.3 kB view details)

Uploaded Python 3

File details

Details for the file grok3api-0.2.1.tar.gz.

File metadata

  • Download URL: grok3api-0.2.1.tar.gz
  • Upload date:
  • Size: 17.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for grok3api-0.2.1.tar.gz
Algorithm Hash digest
SHA256 daf231a763fb6676cf0e32aecd20f5dfcfe2f20b25eb453073362b82f60fe2b2
MD5 2a77d5cf63fc50de2e3fa46b10b5abf9
BLAKE2b-256 1ddbde519deaf2d30ba867877c3cc1e1cf7be208ce08666fac448da4c073ee3f

See more details on using hashes here.

Provenance

The following attestation bundles were made for grok3api-0.2.1.tar.gz:

Publisher: release.yml on boykopovar/Grok3API

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file grok3api-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: grok3api-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 22.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for grok3api-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 4210a47f4fe1b044d028d767f4041a7afcdcf9d7a2fd1c46e3c02b9b04c42958
MD5 7190e7accbc4b686dc5261105f0d2b26
BLAKE2b-256 c36c02b1e4137fa48c8f6bde91a91dc0f6297aabf6f64ba53d03b6056a4a7a73

See more details on using hashes here.

Provenance

The following attestation bundles were made for grok3api-0.2.1-py3-none-any.whl:

Publisher: release.yml on boykopovar/Grok3API

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page