search

tiagosiebler / ftx-api

Node.js connector for the FTX.com & FTX.us APIs and WebSockets, with TypeScript & browser support.
https://www.npmjs.com/package/ftx-api
MIT License
123 stars 47 forks source link

Use standard params #93

Closed tuloski closed 1 year ago

tuloski commented 2 years ago

There are some inconsistencies between params name in the documentation and param names used in this library. For example getOrderbook() uses "marketName" instead of market_name. I didn't check all the paraments to have a list of all inconsistencies and maybe this is the only one.

tiagosiebler commented 2 years ago

While I see your point, for this method the exact property name doesn't matter since it's passed as part of the URL: https://github.com/tiagosiebler/ftx-api/blob/master/src/rest-client.ts#L158-L163

Renaming it now from marketName to market_name would also be a breaking change for any of the existing implementations of this connectors.

I've tried to be consistent in where I used the camel case convention. Snake case is more of a python thing, the only place where this connector should be using those is if the REST API specifically requires it, e.g. this method where parameters are passed as-is in the request body: https://github.com/tiagosiebler/ftx-api/blob/master/src/rest-client.ts#L198-L204