> For the complete documentation index, see [llms.txt](https://painor.gitbook.io/gramjs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://painor.gitbook.io/gramjs/working-with-deep-links/help.getdeeplinkinfo.md).

# help.getDeepLinkInfo

Get info about a t.me link

## Example

{% tabs %}
{% tab title="Javascript" %}

```javascript
const {Api, TelegramClient} = require('telegram');
const {StringSession} = require('telegram/sessions');

const session = new StringSession('');
const client = new TelegramClient(session, apiId, apiHash, {});

(async function run() {
    const result = await client.invoke(new Api.help.getDeepLinkInfo({
        path: 'random string here',
        }));
    console.log(result); // prints the result
})();
```

{% endtab %}

{% tab title="TypeScript" %}

```typescript
import {Api, TelegramClient} from 'telegram';
import {StringSession} from 'telegram/sessions';

const session = new StringSession('');
const client = new TelegramClient(session, apiId, apiHash, {});

(async function run() {
    const result: Api.help.DeepLinkInfo = await client.invoke(new Api.help.getDeepLinkInfo({
        path: 'random string here',
        }));
    console.log(result); // prints the result
})();
```

{% endtab %}
{% endtabs %}

## TL schema

```
t.me
```

## Parameters

|   Name   | Type                                            | Description       |
| :------: | ----------------------------------------------- | ----------------- |
| **path** | [string](https://core.telegram.org/type/string) | Path in t.me/path |

## Result

[help.DeepLinkInfo](https://core.telegram.org/type/help.DeepLinkInfo)

## Possible errors

| Code | Type | Description |
| :--: | ---- | ----------- |

## Can bots use this methd ?

### yes

## Related pages