Skip to main content

Documentation Index

Fetch the complete documentation index at: https://nango.dev/docs/llms.txt

Use this file to discover all available pages before exploring further.

Use the requests proxy to make authenticated API requests to the external API.

How to use the proxy

Make sure you have an integration configured in your environment, and at least one connection available for it. You can use the proxy with the Node SDK or REST API:
try {
    const res = await nango.proxy({
        method: 'POST',
        baseUrlOverride: 'https://api.example.com',
        endpoint: '/external-endpoint',
        providerConfigKey: '<string>',
        connectionId: '<string>',
        retries: 5, // Retries with exponential backoff (optional, default 0)
        data: {
            id: 1,
            colorId: 'blue',
            selected: true
        }
    });

    // Response was 200!
    // See https://axios-http.com/docs/res_schema
    console.log(res.data);
} catch (error) {
    // Status of response != 200
    // See https://axios-http.com/docs/handling_errors
    console.log(error.response.data);
    console.log(error.response.status);
    console.log(error.response.headers);
}