Stock Analysis API (lobster-app-55pwd)

https://lobster-app-55pwd.ondigitalocean.app/docs
Admin
Tokens:1,213
Snippets:4
Trust Score:1.6
Update:10 months ago
Show doc for...
Tokens:
Raw
### Stock Analysis API

Source: https://lobster-app-55pwd.ondigitalocean.app/docs/index

Endpoints for analyzing stock data.

```APIDOC
## GET /api/v1/stock/analyze

### Description
Performs a comprehensive analysis of a stock.

### Method
GET

### Endpoint
/api/v1/stock/analyze

### Parameters
#### Path Parameters
None

#### Query Parameters
- **ticker** (string) - Required - The stock ticker symbol to analyze.

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **analysis_results** (object) - Contains detailed analysis results.
- **fundamentals** (object) - Fundamental financial data for the stock.
- **valuation** (object) - Valuation metrics for the stock.
- **sentiment** (string) - Sentiment analysis of the stock.

#### Response Example
```json
{
  "analysis_results": {
    "summary": "..."
  },
  "fundamentals": {
    "market_cap": 1000000000,
    "pe_ratio": 25.5
  },
  "valuation": {
    "intrinsic_value": 150.75,
    "rating": "BUY"
  },
  "sentiment": "positive"
}
```
```

```APIDOC
## GET /api/v1/stock/quick/{ticker}

### Description
Provides a quick analysis summary for a given stock ticker.

### Method
GET

### Endpoint
/api/v1/stock/quick/{ticker}

### Parameters
#### Path Parameters
- **ticker** (string) - Required - The stock ticker symbol.

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **quick_summary** (string) - A brief summary of the stock's performance and outlook.

#### Response Example
```json
{
  "quick_summary": "AAPL shows strong growth potential with a positive outlook."
}
```
```

--------------------------------

### Deep Research API

Source: https://lobster-app-55pwd.ondigitalocean.app/docs/index

Endpoints for in-depth research on stocks.

```APIDOC
## GET /api/v1/research/deep/{ticker}

### Description
Conducts deep research into a specific stock.

### Method
GET

### Endpoint
/api/v1/research/deep/{ticker}

### Parameters
#### Path Parameters
- **ticker** (string) - Required - The stock ticker symbol for deep research.

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **research_report** (string) - A detailed research report for the stock.

#### Response Example
```json
{
  "research_report": "This report covers the company's financials, market position, and future prospects..."
}
```
```

```APIDOC
## GET /api/v1/research/question/{ticker}

### Description
Answers specific questions related to a stock.

### Method
GET

### Endpoint
/api/v1/research/question/{ticker}

### Parameters
#### Path Parameters
- **ticker** (string) - Required - The stock ticker symbol.

#### Query Parameters
- **question** (string) - Required - The question to be answered about the stock.

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **answer** (string) - The answer to the posed question.

#### Response Example
```json
{
  "answer": "The company's revenue grew by 15% last quarter due to new product launches."
}
```
```

--------------------------------

### Tavily Search API

Source: https://lobster-app-55pwd.ondigitalocean.app/docs/index

Utilizes Tavily search for stock-related information.

```APIDOC
## GET /api/v1/search/tavily/{ticker}

### Description
Performs a search using Tavily for information related to a stock ticker.

### Method
GET

### Endpoint
/api/v1/search/tavily/{ticker}

### Parameters
#### Path Parameters
- **ticker** (string) - Required - The stock ticker symbol to search for.

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **search_results** (array) - A list of search results from Tavily.
  - **title** (string) - The title of the search result.
  - **url** (string) - The URL of the search result.
  - **content** (string) - A snippet of the content from the search result.

#### Response Example
```json
{
  "search_results": [
    {
      "title": "Company XYZ Financial Report",
      "url": "http://example.com/report",
      "content": "The latest financial report for Company XYZ shows...
"
    }
  ]
}
```
```

--------------------------------

### Health Check API

Source: https://lobster-app-55pwd.ondigitalocean.app/docs/index

Provides a health check for the API.

```APIDOC
## GET /

### Description
Root endpoint for the API.

### Method
GET

### Endpoint
/

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **message** (string) - A status message indicating the API is operational.

#### Response Example
```json
{
  "message": "Welcome to the Stock Due Diligence API!"
}
```
```

```APIDOC
## GET /health

### Description
Checks the health status of the API.

### Method
GET

### Endpoint
/health

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **status** (string) - The health status of the API (e.g., "ok").

#### Response Example
```json
{
  "status": "ok"
}
```
```
Tokens:
Raw