> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Twitterapi: Check Follow Relationship

> Check whether one account follows / is followed by another. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Check whether one account follows / is followed by another.

> [!NOTE]
>
> Tool ID: `twitterapi_check_follow_relationship`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'twitterapi_check_follow_relationship',
  {
    "source_user_name": "Example",
    "target_user_name": "Example"
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute twitterapi_check_follow_relationship --input '{
  "source_user_name": "Example",
  "target_user_name": "Example"
}' --json
```

## Input reference

Check whether source follows / is followed by target.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.source_user_name` | `string` | Yes | — | Minimum length: 1. |
| `payload.target_user_name` | `string` | Yes | — | Minimum length: 1. |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Check whether source follows / is followed by target.",
    "properties": {
      "source_user_name": {
        "type": "string",
        "minLength": 1
      },
      "target_user_name": {
        "type": "string",
        "minLength": 1
      }
    },
    "required": [
      "source_user_name",
      "target_user_name"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

The static output schema is not available. Run `deepline describe twitterapi_check_follow_relationship --json` for the live contract.

## Deepline cost

* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0.02` per pricing unit.

## Related documentation

* [Twitterapi provider guide](https://deepline.com/docs/providers/twitterapi/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.