Laevitas / laevitas-feature-issue-tracker

4 stars 0 forks source link

Some API Endpoints Lack a Name; Undocumented APIs? #3

Closed joemccann closed 1 year ago

joemccann commented 1 year ago

After callling the catalog method, some of the API endpoints lack a name value. Are these undocumented APIs? If so, what do they do?

[
  {
    name: '',
    path: '/analytics/options/custom_change/{name}/{market}/{currency}',
    format: 'JSON',
    query_params: { end: [ '2023-07-31' ], start: [ '2023-07-24' ] },
    path_params: {
      name: [
        'historical_buy_sell_volume',
        'atmivts_historical',
        'heatmap_change',
        'oi_net_change',
        'iv_table_change',
        'time_skew',
        'oi_gainers_and_losers'
      ],
      market: [
        'deribit',
        'okex',
        'bit',
        'bybit',
        'powertrade',
        'delta_exchange',
        'zeta_exchange'
      ],
      currency: [ 'btc', 'eth', 'sol' ]
    }
  },
  {
    name: '',
    path: '/pricer/risk_slide/{market}/{currency}',
    format: 'JSON',
    query_params: { instrument: [ 'BTC-3MAR23-25000-C' ] },
    path_params: { market: [ 'deribit' ], currency: [ 'BTC' ] }
  },
  {
    name: '',
    path: '/pricer/risk_slide_shocked/{market}/{currency}',
    format: 'JSON',
    query_params: { atm_iv_shock: [ '-5' ], spot_shock: [ '0.1' ] },
    path_params: { market: [ 'deribit' ], currency: [ 'BTC' ] }
  },
  {
    name: '',
    path: '/pricer/risk_slide_instruments/{market}',
    format: 'JSON',
    path_params: { market: [ 'deribit' ] }
  },
  {
    name: '',
    path: '/pricer/risk_slide',
    format: 'JSON',
    query_params: {
      atmiv_shocks: [ '-1,1,0' ],
      spot_shocks: [ '1,1,2' ],
      currency: [ 'BTC' ],
      market: [ 'deribit' ]
    }
  },
  { name: '', path: '/pricer/price', format: 'JSON' }
joemccann commented 1 year ago

@Rassilo tagging you but please tag anyone else from the team.

Rassilo commented 1 year ago

@MoetezL will handle this issue

Rassilo commented 1 year ago

@joemccann we updated the missing documentation on those endpoint, you can confirm for us. thanks for your feedback