Does GraphQL support dynamic field aliases based on input arguments?

Question

In GraphQL, is there any way to alias the returned value using an input argument?

e.g. here:

query GetCurrencyRevenueAggregate(
  $currency: String!
  $startDate: timestamptz!
  $endDate: timestamptz!
) {
  DailyCurrencyRevenue_aggregate(
    where: {
      currency: { _eq: $currency }
      dateTimestamp: { _gte: $startDate, _lt: $endDate }
    }
  ) {
    aggregate {
      sum {
        amountETH: amount # <--- see this
      }
    }
  }
}

I would like to alias amountETH to amount_{$currency}

Is this possible in GraphQL?

Have you considered using an input on the amount parameter? amount(code: CURRENCY_CODE): Int? — Dan Crews
– Dan Crews, Commented Oct 10 at 21:03

kkmonlee · Accepted Answer · 2025-08-27 10:09:12Z

3

GraphQL intentionally avoids dynamic field names to keep the response shape predictable and type-safe. Aliases are part of the query document and must be static at parse time. A workaround is to query with a static (or no) alias, then rename the key in your client-side code:

const amount = data.DailyCurrencyRevenue_aggregate.aggregate.sum.amount;
const aliased = { [`amount_${variables.currency}`]: amount };

You could also generate the query with the alias baked in but this brings its fair share of sanitisation issues and cache/persisted-query misses.

const alias = `amount_${currency}`;
const query = `
  query ($currency: String!, $startDate: timestamptz!, $endDate: timestamptz!) {
    DailyCurrencyRevenue_aggregate(where:{
      currency:{_eq:$currency}
      dateTimestamp:{_gte:$startDate,_lt:$endDate}
    }) {
      aggregate { sum { ${alias}: amount } }
    }
  }
`;

answered Aug 27 at 10:09

kkmonlee

5013 silver badges18 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

Bergi Aug 27 at 16:08

"this brings its fair share of sanitisation issues" - yes. Make sure currency is not controlled by the user (or potentially an attacker), it could easily lead to query syntax errors or even to security issues.

Collectives™ on Stack Overflow

Does GraphQL support dynamic field aliases based on input arguments?

1 Answer 1

1 Comment

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

1 Comment

Your Answer

Sign up or log in

Post as a guest

Related