Skip to content

Tokens

get_token() async

Get the token used to access OpenBB.

Returns:

Type Description
TokenResponse

TokenResponse: token for OpenBB.

Source code in projects/gptstonks_api/gptstonks/api/routers/tokens.py
@router.get("/", tags=["tokens"])
async def get_token() -> TokenResponse:
    """Get the token used to access OpenBB.

    Returns:
        `TokenResponse`: token for OpenBB.
    """
    token = db.tokens.find_one({}, {"_id": 0, "openbb": 1})
    return TokenResponse.model_validate(token) if token else TokenResponse(openbb="")

update_token(token_data) async

Update the token used to access OpenBB.

Parameters:

Name Type Description Default
token_data `TokenData`

Token data information to update the database.

required

Returns:

Type Description
MessageResponse

MessageResponse: message indicating success.

Source code in projects/gptstonks_api/gptstonks/api/routers/tokens.py
@router.post("/", tags=["tokens"])
async def update_token(token_data: TokenData) -> MessageResponse:
    """Update the token used to access OpenBB.

    Args:
        token_data (`TokenData`): Token data information to update the database.

    Returns:
        `MessageResponse`: message indicating success.
    """
    db.tokens.update_one({}, {"$set": token_data.dict()}, upsert=True)
    return MessageResponse(message="Token updated")